LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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 >:
lsst::modelfit::parameters::Object

Public Member Functions

bool check (T value) const
 Check if a value is within the limits.
 
clip (T value) const
 Return the closest value to the input that is within the limits.
 
get_min () const
 Return the minimum.
 
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
TThe 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.

109 : _min(min), _max(max), name(name_) {
110 _check(min, max);
111 }
Range-based limits for parameter values.
Definition limits.h:45

◆ ~Limits()

template<typename T>
lsst::modelfit::parameters::Limits< T >::~Limits ( )
inline

Definition at line 113 of file limits.h.

113{};

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.

67{ 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.

69{ 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.

74{ 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.

72{ 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_keywordsWhether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separatorThe 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.

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

◆ 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.

79 {
80 _check(min, max);
81 _min = min;
82 _max = max;
83 }

◆ 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.

90 {
91 _check_max(max);
92 _max = max;
93 };

◆ 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.

85 {
86 _check_min(min);
87 _min = min;
88 };

◆ 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.

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

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: