A parameter with values and metadata. More...

#include <parameter.h>

Inheritance diagram for lsst::modelfit::parameters::Parameter< T, C >:

Public Member Functions
std::string	get_desc () const override
	Get a string description for this parameter class.

T	get_default () const override
	Get the default value.

bool	get_fixed () const override
	Return whether the parameter is fixed (not free).

bool	get_free () const override
	Return whether the parameter is free (not fixed).

std::string	get_label () const override
	Return a string label for this parameter instance.

const Limits< T > &	get_limits_maximal () const override
	Return limits representing the maximum/minimum untransformed value.

const Limits< T > &	get_limits () const override
	Return the limits for the untransformed value.

bool	get_linear () const override
	Return whether the parameter is linear.

T	get_min () const override
	Return the minimum value for this parameter instance.

T	get_max () const override
	Return the maximum value for this parameter instance.

std::string	get_name () const override
	Get a string name for this parameter class.

const Transform< T > &	get_transform () const override
	Return the transforming function for this parameter instance.

std::shared_ptr< const Transform< T > >	get_transform_ptr () const override
	Return the transform pointer for this parameter instance.

T	get_transform_derivative () const override
	Return the derivative of the transform for this parameter instance.

const Unit &	get_unit () const override
	Return the unit of this parameter instance.

T	get_value () const override
	Return the untransformed value of this parameter instance.

T	get_value_transformed () const override
	Return the transformed value of this parameter instance.

std::shared_ptr< C >	ptr ()
	Return a shared pointer to this.

void	set_fixed (bool fixed) override
	Set the parameter to be fixed (or not).

void	set_free (bool free) override
	Set the parameter to be free (or not).

void	set_label (std::string label) override
	Set the string label for this parameter instance.

void	set_limits (std::shared_ptr< const Limits< T > > limits) override
	Set the limits for this parameter instance.

void	set_transform (const std::shared_ptr< const Transform< T > > transform) override
	Set the transforming function for this parameter instance.

void	set_value (T value) override
	Set the untransformed value for this parameter instance.

void	set_value_transformed (T value_transformed) override
	Set the transformed value for this parameter instance.

void	set_unit (std::shared_ptr< const Unit > unit=nullptr) override
	Set the unit for this parameter instance.

std::string	repr (bool name_keywords=false, const std::string_view &namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
	Return a full, callable string representation of this.

std::string	str () const override
	Return a brief, human-readable string representation of this.

	Parameter (T value=_get_default(), std::shared_ptr< const Limits< T > > limits=nullptr, const std::shared_ptr< const Transform< T > > transform=nullptr, std::shared_ptr< const Unit > unit=nullptr, bool fixed=false, std::string label="")
	Initialize a Parameter.

	~Parameter ()

T	shared_from_this (T... args)

Static Public Member Functions
static constexpr T	_get_default ()
	Get the default value for the derived type of this.

static const std::string	get_type_name (bool strip_namespace_separator=false, const std::string_view &namespace_separator=detail::NAMESPACE_SEPARATOR)
	Get the name of the derived type of this.

static const UnitTransform< T > &	transform_none ()

Static Public Attributes
static constexpr std::string_view	CC_NAMESPACE_SEPARATOR = "::"
	The C++ namespace separator.

Static Protected Member Functions
static const std::string	_get_desc ()

static constexpr bool	_get_linear ()

static constexpr T	_get_min ()

static constexpr T	_get_max ()

static const std::string	_get_name ()

Protected Attributes
T	_value
	The untransformed value.

T	_value_transformed
	The cached, transformed value.

Detailed Description

template<typename T, class C>
class lsst::modelfit::parameters::Parameter< T, C >

A parameter with values and metadata.

This is a CRTP implementation of the ParameterBase interface, which allows for concise, minimal-effort derived classes (see tests and examples).

Template Parameters

T	The type of the value. Only floating point values are tested.
C	The derived class.

Note: Parameters can be set as free/fixed when they are part of a model. This designation is indicative and does not prevent the parameter value from being changed by users.; CRTP performance benefits are likely lost by having an abstract base class with virtual methods; see ParameterBase Notes. This may be obviated by future compiler improvements.; The main benefit of CRTP left is that derived classes can be implemented just by defining static members. The implementation thereof in this class is not trivial, however.

Definition at line 150 of file parameter.h.

Constructor & Destructor Documentation

◆ Parameter()

template<typename T, class C>

lsst::modelfit::parameters::Parameter< T, C >::Parameter	(	T	value = _get_default(),
		std::shared_ptr< const Limits< T > >	limits = nullptr,
		const std::shared_ptr< const Transform< T > >	transform = nullptr,
		std::shared_ptr< const Unit >	unit = nullptr,
		bool	fixed = false,
		std::string	label = "" )

inline

Initialize a Parameter.

Parameters

value	The initial untransformed value.
limits	The untransformed value limits.
transform	The transformation to apply to values.
unit	The unit of the untransformed value.
fixed	Whether the parameter is fixed in models.
label	A descriptive label for the parameter.

Definition at line 343 of file parameter.h.

            : ParameterBase<T>() {
        set_limits(limits);
        _value = value;
        set_transform(transform == nullptr ? nullptr : std::move(transform));
        set_unit(unit);
        set_fixed(fixed);
        set_label(label);
    }

◆ ~Parameter()

template<typename T, class C>

lsst::modelfit::parameters::Parameter< T, C >::~Parameter ( )

inline

Definition at line 354 of file parameter.h.

354{};

Member Function Documentation

◆ _get_default()

template<typename T, class C>

static constexpr T lsst::modelfit::parameters::Parameter< T, C >::_get_default ( )

inlinestaticconstexpr

Get the default value for the derived type of this.

Definition at line 212 of file parameter.h.

212{ return C::_default; }

◆ _get_desc()

template<typename T, class C>

static const std::string lsst::modelfit::parameters::Parameter< T, C >::_get_desc ( )

inlinestaticprotected

Definition at line 204 of file parameter.h.

204{ return C::_desc; }

◆ _get_linear()

template<typename T, class C>

static constexpr bool lsst::modelfit::parameters::Parameter< T, C >::_get_linear ( )

inlinestaticconstexprprotected

Definition at line 205 of file parameter.h.

205{ return C::_linear; }

◆ _get_max()

template<typename T, class C>

static constexpr T lsst::modelfit::parameters::Parameter< T, C >::_get_max ( )

inlinestaticconstexprprotected

Definition at line 207 of file parameter.h.

207{ return C::_max; }

◆ _get_min()

template<typename T, class C>

static constexpr T lsst::modelfit::parameters::Parameter< T, C >::_get_min ( )

inlinestaticconstexprprotected

Definition at line 206 of file parameter.h.

206{ return C::_min; }

◆ _get_name()

template<typename T, class C>

static const std::string lsst::modelfit::parameters::Parameter< T, C >::_get_name ( )

inlinestaticprotected

Definition at line 208 of file parameter.h.

208{ return C::_name; }

◆ get_default()

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::get_default ( ) const

inlineoverridevirtual

Get the default value.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 216 of file parameter.h.

216{ return _get_default(); }

lsst::modelfit::parameters::Parameter::_get_default

static constexpr T _get_default()

Get the default value for the derived type of this.

Definition parameter.h:212

◆ get_desc()

template<typename T, class C>

std::string lsst::modelfit::parameters::Parameter< T, C >::get_desc ( ) const

inlineoverridevirtual

Get a string description for this parameter class.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 214 of file parameter.h.

214{ return _get_desc(); }

lsst::modelfit::parameters::Parameter::_get_desc

static const std::string _get_desc()

Definition parameter.h:204

◆ get_fixed()

template<typename T, class C>

bool lsst::modelfit::parameters::Parameter< T, C >::get_fixed ( ) const

inlineoverridevirtual

Return whether the parameter is fixed (not free).

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 218 of file parameter.h.

218{ return !_free; }

◆ get_free()

template<typename T, class C>

bool lsst::modelfit::parameters::Parameter< T, C >::get_free ( ) const

inlineoverridevirtual

Return whether the parameter is free (not fixed).

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 220 of file parameter.h.

220{ return _free; }

◆ get_label()

template<typename T, class C>

std::string lsst::modelfit::parameters::Parameter< T, C >::get_label ( ) const

inlineoverridevirtual

Return a string label for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 222 of file parameter.h.

222{ return _label; }

◆ get_limits()

template<typename T, class C>

const Limits< T > & lsst::modelfit::parameters::Parameter< T, C >::get_limits ( ) const

inlineoverridevirtual

Return the limits for the untransformed value.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 230 of file parameter.h.

230{ return _limiter->limits; }

◆ get_limits_maximal()

template<typename T, class C>

const Limits< T > & lsst::modelfit::parameters::Parameter< T, C >::get_limits_maximal ( ) const

inlineoverridevirtual

Return limits representing the maximum/minimum untransformed value.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 224 of file parameter.h.

                                                         {
        static const Limits<T> limits_maximal
                = Limits<T>(_get_min(), _get_max(), std::string(type_name<C>()) + ".limits_maximal");
        return limits_maximal;
    }

◆ get_linear()

template<typename T, class C>

bool lsst::modelfit::parameters::Parameter< T, C >::get_linear ( ) const

inlineoverridevirtual

Return whether the parameter is linear.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 232 of file parameter.h.

232{ return _get_linear(); }

lsst::modelfit::parameters::Parameter::_get_linear

static constexpr bool _get_linear()

Definition parameter.h:205

◆ get_max()

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::get_max ( ) const

inlineoverridevirtual

Return the maximum value for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 236 of file parameter.h.

236{ return _get_max(); }

◆ get_min()

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::get_min ( ) const

inlineoverridevirtual

Return the minimum value for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 234 of file parameter.h.

234{ return _get_min(); }

◆ get_name()

template<typename T, class C>

std::string lsst::modelfit::parameters::Parameter< T, C >::get_name ( ) const

inlineoverridevirtual

Get a string name for this parameter class.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 238 of file parameter.h.

238{ return _get_name(); }

lsst::modelfit::parameters::Parameter::_get_name

static const std::string _get_name()

Definition parameter.h:208

◆ get_transform()

template<typename T, class C>

const Transform< T > & lsst::modelfit::parameters::Parameter< T, C >::get_transform ( ) const

inlineoverridevirtual

Return the transforming function for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 240 of file parameter.h.

240{ return _transformer->transform; }

◆ get_transform_derivative()

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::get_transform_derivative ( ) const

inlineoverridevirtual

Return the derivative of the transform for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 244 of file parameter.h.

                                                {
        return this->get_transform().derivative(this->get_value());
    }

◆ get_transform_ptr()

template<typename T, class C>

std::shared_ptr< const Transform< T > > lsst::modelfit::parameters::Parameter< T, C >::get_transform_ptr ( ) const

inlineoverridevirtual

Return the transform pointer for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 242 of file parameter.h.

242{ return _transform_ptr; }

◆ get_type_name()

template<typename T, class C>

static const std::string lsst::modelfit::parameters::Parameter< T, C >::get_type_name	(	bool	strip_namespace_separator = false,
		const std::string_view &	namespace_separator = detail::NAMESPACE_SEPARATOR )

inlinestatic

Get the name of the derived type of this.

Definition at line 248 of file parameter.h.

                                                                        {
        return type_name_str<C>(strip_namespace_separator, namespace_separator);
    }

◆ get_unit()

template<typename T, class C>

const Unit & lsst::modelfit::parameters::Parameter< T, C >::get_unit ( ) const

inlineoverridevirtual

Return the unit of this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 254 of file parameter.h.

254{ return *_unit_ptr; }

◆ get_value()

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::get_value ( ) const

inlineoverridevirtual

Return the untransformed value of this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 256 of file parameter.h.

256{ return _value; }

◆ get_value_transformed()

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::get_value_transformed ( ) const

inlineoverridevirtual

Return the transformed value of this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 258 of file parameter.h.

258{ return _value_transformed; }

lsst::modelfit::parameters::Parameter::_value_transformed

T _value_transformed

The cached, transformed value.

Definition parameter.h:202

◆ ptr()

template<typename T, class C>

std::shared_ptr< C > lsst::modelfit::parameters::Parameter< T, C >::ptr ( )

inline

Return a shared pointer to this.

Definition at line 261 of file parameter.h.

261{ return this->shared_from_this(); }

std::enable_shared_from_this< C >::shared_from_this

T shared_from_this(T... args)

◆ repr()

template<typename T, class C>

std::string lsst::modelfit::parameters::Parameter< T, C >::repr	(	bool	name_keywords = false,
		const std::string_view &	namespace_separator = Object::CC_NAMESPACE_SEPARATOR ) const

inlineoverridevirtual

Return a full, callable string representation of this.

Parameters

name_keywords	Whether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separator	The string to use to delimit namespaces, i.e. :: in C++ and . in Python.

Returns: A callable string representation of this, which should return an an identical object to this.

Note: The representation with name_keywords=false must be callable in C++. The representation with name_keywords=true should be callable in Python, if there are any bindings.

Implements lsst::modelfit::parameters::Object.

Definition at line 312 of file parameter.h.

                                                                                                {
        return get_type_name(false, namespace_separator) + "(" + (name_keywords ? "value=" : "")
               + std::to_string(_value) + ", " + (name_keywords ? "limits=" : "") + get_limits().repr() + ", "
               + (name_keywords ? "transform=" : "") + get_transform().repr() + ", "
               + (name_keywords ? "fixed=" : "") + std::to_string(0 + get_fixed()) + ", "
               + (name_keywords ? "label='" : "'") + _label + "')";
    }

◆ set_fixed()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_fixed ( bool fixed )

inlineoverridevirtual

Set the parameter to be fixed (or not).

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 263 of file parameter.h.

263{ set_free(!fixed); }

lsst::modelfit::parameters::Parameter::set_free

void set_free(bool free) override

Set the parameter to be free (or not).

Definition parameter.h:264

◆ set_free()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_free ( bool free )

inlineoverridevirtual

Set the parameter to be free (or not).

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 264 of file parameter.h.

264{ _free = free; }

◆ set_label()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_label ( std::string label )

inlineoverridevirtual

Set the string label for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 265 of file parameter.h.

265{ _label = std::move(label); }

std::move

T move(T... args)

◆ set_limits()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_limits ( std::shared_ptr< const Limits< T > > limits )

inlineoverridevirtual

Set the limits for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 266 of file parameter.h.

                                                                    {
        // TODO: Fix bad_alloc when calling this without &
        // Disable copy constructor explicitly maybe?
        const auto& limits_maximal = this->get_limits_maximal();
        if (limits == nullptr) {
            _limiter = std::make_unique<Limiter>(limits_maximal);
        } else {
            if (!((limits->get_min() >= this->get_min()) && (limits->get_max() <= this->get_max()))) {
                std::string error = get_type_name() + ".set_limits(" + limits->str()
                                    + ") sets limits that are less restrictive than the minimum="
                                    + limits_maximal.str();
                throw std::runtime_error(error);
            }
            _limits_ptr = std::move(limits);
            _limiter = std::make_unique<Limiter>(*_limits_ptr);
        }
    }

◆ set_transform()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_transform ( const std::shared_ptr< const Transform< T > > transform )

inlineoverridevirtual

Set the transforming function for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 283 of file parameter.h.

                                                                                   {
        if (transform == nullptr) {
            // TODO: determine why passing transform_none as arg here returns:
            // error: modification of '<temporary>' is not a constant expression
            // whereas get_transform_unit<T>() results in a segfault
            // (iff Transform has a virtual destructor)
            _transformer = std::make_unique<Transformer>(this->transform_none());
        } else {
            _transform_ptr = std::move(transform);
            _transformer = std::make_unique<Transformer>(*_transform_ptr);
        }
        _value_transformed = _transformer->transform.forward(_value);
    }

◆ set_unit()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_unit ( std::shared_ptr< const Unit > unit = nullptr )

inlineoverridevirtual

Set the unit for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 308 of file parameter.h.

                                                                     {
        _unit_ptr = unit == nullptr ? nullptr : std::move(unit);
    }

◆ set_value()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_value ( T value )

inlineoverridevirtual

Set the untransformed value for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 297 of file parameter.h.

                                     {
        _set_value(value);
        double value_new = this->get_value();
        _value_transformed = _transformer->transform.forward(value_new);
    };

◆ set_value_transformed()

template<typename T, class C>

void lsst::modelfit::parameters::Parameter< T, C >::set_value_transformed ( T value_transformed )

inlineoverridevirtual

Set the transformed value for this parameter instance.

Implements lsst::modelfit::parameters::ParameterBase< T >.

Definition at line 303 of file parameter.h.

                                                             {
        _set_value(_transformer->transform.reverse(value_transformed));
        _value_transformed = _transformer->transform.forward(this->get_value());
    }

◆ str()

template<typename T, class C>

std::string lsst::modelfit::parameters::Parameter< T, C >::str ( ) const

inlineoverridevirtual

Return a brief, human-readable string representation of this.

Implements lsst::modelfit::parameters::Object.

Definition at line 321 of file parameter.h.

                                   {
        return get_type_name(true) + "(value=" + std::to_string(_value)
               + ", "
               // TODO: Implement equality operators for limits/transforms
               + ((&get_limits() == &get_limits_maximal()) ? "" : ("limits=" + get_limits().repr() + ", "))
               + ((&get_transform() == &(this->transform_none()))
                          ? ""
                          : ("transform=" + get_transform().repr() + ", "))
               + (!get_fixed() ? "" : (std::string("fixed=") + std::to_string(0 + get_fixed()) + ", "))
               + ((get_label() == "") ? "" : ("label='" + get_label() + "'")) + ")";
    }

◆ transform_none()

template<typename T>

static const UnitTransform< T > & lsst::modelfit::parameters::ParameterBase< T >::transform_none ( )

inlinestaticinherited

Definition at line 111 of file parameter.h.

111{ return UnitTransform<T>::get(); };

lsst::modelfit::parameters::UnitTransform::get

static const UnitTransform< T > & get()

Definition transform.h:64

Member Data Documentation

◆ _value

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::_value

protected

The untransformed value.

Definition at line 200 of file parameter.h.

◆ _value_transformed

template<typename T, class C>

T lsst::modelfit::parameters::Parameter< T, C >::_value_transformed

protected

The cached, transformed value.

Definition at line 202 of file parameter.h.

◆ CC_NAMESPACE_SEPARATOR

std::string_view lsst::modelfit::parameters::Object::CC_NAMESPACE_SEPARATOR = "::"

staticconstexprinherited

The C++ namespace separator.

Definition at line 42 of file object.h.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-11.0.0/Linux/modelfit_parameters/g35bb328faa+8c5ae1fdc5/include/lsst/modelfit/parameters/parameter.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Parameter()

◆ ~Parameter()

Member Function Documentation

◆ _get_default()

◆ _get_desc()

◆ _get_linear()

◆ _get_max()

◆ _get_min()

◆ _get_name()

◆ get_default()

◆ get_desc()

◆ get_fixed()

◆ get_free()

◆ get_label()

◆ get_limits()

◆ get_limits_maximal()

◆ get_linear()

◆ get_max()

◆ get_min()

◆ get_name()

◆ get_transform()

◆ get_transform_derivative()

◆ get_transform_ptr()

◆ get_type_name()

◆ get_unit()

◆ get_value()

◆ get_value_transformed()

◆ ptr()

◆ repr()

◆ set_fixed()

◆ set_free()

◆ set_label()

◆ set_limits()

◆ set_transform()

◆ set_unit()

◆ set_value()

◆ set_value_transformed()

◆ str()

◆ transform_none()

Member Data Documentation

◆ _value

◆ _value_transformed

◆ CC_NAMESPACE_SEPARATOR