#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

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.

Additional Inherited Members
Static Public Attributes inherited from lsst::modelfit::parameters::Object
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.

Member Function Documentation

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.

template<typename T>

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

inlineoverridevirtual

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

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