Source code for bluepyopt.parameters

"""Parameter classes"""

"""
Copyright (c) 2016-2020, EPFL/Blue Brain Project

 This file is part of BluePyOpt <https://github.com/BlueBrain/BluePyOpt>

 This library is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License version 3.0 as published
 by the Free Software Foundation.

 This library is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 details.

 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""


[docs]class Parameter(object):

    """Base parameter class"""

    def __init__(self, name, value=None, frozen=False, bounds=None,
                 param_dependencies=None):
        """Constructor"""

        self.name = name
        self.prefix = None
        self.bounds = bounds
        self._value = value
        self.check_bounds()
        self.frozen = frozen
        self.param_dependencies = param_dependencies
        if param_dependencies is None:
            self.param_dependencies = []

    @property
    def lower_bound(self):
        """Lower bound"""
        if self.bounds is not None:
            return self.bounds[0]
        else:
            return None

    @property
    def upper_bound(self):
        """Lower bound"""
        if self.bounds is not None:
            return self.bounds[1]
        else:
            return None

    @property
    def value(self):
        """Parameter value"""
        return self._value

[docs]    def freeze(self, value):
        """Freeze parameter to certain value"""
        self.value = value
        self.frozen = True

[docs]    def unfreeze(self):
        """Unfreeze parameter"""
        self._value = None
        self.frozen = False

    @value.setter
    def value(self, value):
        """Set parameter value"""
        if self.frozen:
            raise Exception(
                'Parameter: parameter %s is frozen, unable to change value' %
                self.name)
        else:
            self._value = value
            self.check_bounds()

[docs]    def check_bounds(self):
        """Check if parameter is within bounds"""
        if self.bounds and self._value is not None:
            if not self.lower_bound <= self._value <= self.upper_bound:
                raise ValueError(
                    'Parameter %s has value %s outside of bounds [%s, %s]' %
                    (self.name, self._value, str(self.lower_bound),
                     str(self.upper_bound)))

    def __str__(self):
        """String representation"""
        return '%s: value = %s' % (
            self.name, self.value if self.frozen else self.bounds)


[docs]class MetaListEqualParameter(Parameter):

    """Metaparameter that makes sure list of parameter values are all equal"""

    def __init__(self, name, value=None, frozen=False,
                 bounds=None, sub_parameters=None):
        """Constructor"""

        if sub_parameters is None:
            raise ValueError(
                'MetaListEqualParameter: impossible to have None as '
                'sub_parameters attribute')
        else:
            self.sub_parameters = sub_parameters

        super(
            MetaListEqualParameter,
            self).__init__(
            name,
            value=value,
            frozen=frozen,
            bounds=bounds)

        if value is not None:
            for sub_parameter in self.sub_parameters:
                sub_parameter.value = value

    @Parameter.value.setter
    def value(self, value):
        """Set parameter value"""

        for sub_parameter in self.sub_parameters:
            sub_parameter.value = value

        Parameter.value.fset(self, value)

[docs]    def freeze(self, value):
        """Freeze parameter to certain value"""

        super(MetaListEqualParameter, self).freeze(value)

        for sub_parameter in self.sub_parameters:
            sub_parameter.frozen = True

[docs]    def unfreeze(self):
        """Unfreeze parameter"""
        for sub_parameter in self.sub_parameters:
            sub_parameter.unfreeze()

        super(MetaListEqualParameter, self).unfreeze()

[docs]    def check_bounds(self):
        """Check if parameter is within bounds"""

        for sub_parameter in self.sub_parameters:
            sub_parameter.check_bounds()

        super(MetaListEqualParameter, self).check_bounds()

    def __str__(self):
        """String representation"""

        return '%s (sub_params: %s): value = %s' % (self.name, ",".join(
            str(sub_param)
            for sub_param in
            self.sub_parameters),
            self.value
            if self.frozen else
            self.bounds)