LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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: