lsst::modelfit::parameters::Limits< T > Class Template Reference

Range-based limits for parameter values. More...

#include <limits.h>

Inheritance diagram for lsst::modelfit::parameters::Limits< T >:

Public Member Functions
bool	check (T value) const
	Check if a value is within the limits.
T	clip (T value) const
	Return the closest value to the input that is within the limits.
T	get_min () const
	Return the minimum.
T	get_max () const
	Return the maximum.
void	set (T min, T max)
	Set the minimum and maximum.
void	set_min (T min)
	Set the minimum.
void	set_max (T max)
	Set the maximum.
std::string	repr (bool name_keywords=false, const std::string_view &namespace_separator=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.
	Limits (T min=-std::numeric_limits< T >::infinity(), T max=std::numeric_limits< T >::infinity(), std::string name_="")
	Initialize limits from the minimum and maximum value.
	~Limits ()

Public Attributes
std::string	name

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

Detailed Description

template<typename T>
class lsst::modelfit::parameters::Limits< T >

Range-based limits for parameter values.

Template Parameters

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

Definition at line 45 of file limits.h.

Constructor & Destructor Documentation

Limits()

template<typename T>

lsst::modelfit::parameters::Limits< T >::Limits ( T min = -std::numeric_limits<T>::infinity(), T max = std::numeric_limits<T>::infinity(), std::string name_ = "" )

inline

Initialize limits from the minimum and maximum value.

Definition at line 107 of file limits.h.

            : _min(min), _max(max), name(name_) {
        _check(min, max);
    }

~Limits()

template<typename T>

lsst::modelfit::parameters::Limits< T >::~Limits ( )

inline

Definition at line 113 of file limits.h.

{};

Member Function Documentation

check()

template<typename T>

bool lsst::modelfit::parameters::Limits< T >::check ( T value ) const

inline

Check if a value is within the limits.

Definition at line 67 of file limits.h.

{ return value >= _min && value <= _max; }

clip()

template<typename T>

T lsst::modelfit::parameters::Limits< T >::clip ( T value ) const

inline

Return the closest value to the input that is within the limits.

Definition at line 69 of file limits.h.

{ return value > _max ? _max : (value < _min ? _min : value); }

get_max()

template<typename T>

T lsst::modelfit::parameters::Limits< T >::get_max ( ) const

inline

Return the maximum.

Definition at line 74 of file limits.h.

{ return _max; };

get_min()

template<typename T>

T lsst::modelfit::parameters::Limits< T >::get_min ( ) const

inline

Return the minimum.

Definition at line 72 of file limits.h.

{ return _min; };

repr()

template<typename T>

std::string lsst::modelfit::parameters::Limits< T >::repr ( bool name_keywords = false, const std::string_view & namespace_separator = 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 95 of file limits.h.

                                                                                                        {
        return type_name_str<Limits<T>>(false, namespace_separator) + "(" + (name_keywords ? "min=" : "")
               + std::to_string(_min) + ", " + (name_keywords ? "max=" : "") + std::to_string(_max) + ", "
               + (name_keywords ? "name='" : "") + name + "')";
    }

set()

template<typename T>

void lsst::modelfit::parameters::Limits< T >::set ( T min, T max )

inline

Set the minimum and maximum.

Definition at line 79 of file limits.h.

                           {
        _check(min, max);
        _min = min;
        _max = max;
    }

set_max()

template<typename T>

void lsst::modelfit::parameters::Limits< T >::set_max ( T max )

inline

Set the maximum.

Definition at line 90 of file limits.h.

                        {
        _check_max(max);
        _max = max;
    };

set_min()

template<typename T>

void lsst::modelfit::parameters::Limits< T >::set_min ( T min )

inline

Set the minimum.

Definition at line 85 of file limits.h.

                        {
        _check_min(min);
        _min = min;
    };

str()

template<typename T>

std::string lsst::modelfit::parameters::Limits< T >::str ( ) const

inlineoverridevirtual

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

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

Definition at line 101 of file limits.h.

                                   {
        return type_name_str<Limits<T>>(true) + "(" + std::to_string(_min) + ", " + std::to_string(_max)
               + ", '" + name + "')";
    }

Member Data Documentation

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.

name

template<typename T>

std::string lsst::modelfit::parameters::Limits< T >::name

Definition at line 76 of file limits.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/modelfit_parameters/g35bb328faa+fcb1d3bbc8/include/lsst/modelfit/parameters/limits.h