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

#include <transform.h>

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

Public Member Functions
std::string	description () const override
	Return a description of this transform.
std::string	repr (bool=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.
T	derivative (T) const override
	Return the derivative of this tranform at the value x.
T	forward (T x) const override
	Return the transformed value of x.
T	reverse (T x) const override
	Return the original value of x given a transformed value.
	~UnitTransform ()=default

Static Public Member Functions
static const UnitTransform< T > &	get ()

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

Detailed Description

template<class T>
class lsst::modelfit::parameters::UnitTransform< T >

Definition at line 61 of file transform.h.

Constructor & Destructor Documentation

~UnitTransform()

template<class T >

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

default

Member Function Documentation

derivative()

template<class T >

T lsst::modelfit::parameters::UnitTransform< T >::derivative ( T x ) const

inlineoverridevirtual

Return the derivative of this tranform at the value x.

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

Definition at line 74 of file transform.h.

{ return 1; }

description()

template<class T >

std::string lsst::modelfit::parameters::UnitTransform< T >::description ( ) const

inlineoverridevirtual

Return a description of this transform.

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

Definition at line 63 of file transform.h.

{ return "Unit transform"; }

forward()

template<class T >

T lsst::modelfit::parameters::UnitTransform< T >::forward ( T x ) const

inlineoverridevirtual

Return the transformed value of x.

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

Definition at line 75 of file transform.h.

{ return x; }

get()

template<class T >

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

inlinestatic

Definition at line 64 of file transform.h.

                                         {
        static const auto transform = UnitTransform<T>();
        return transform;
    }

repr()

template<class T >

std::string lsst::modelfit::parameters::UnitTransform< T >::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 68 of file transform.h.

                                                                                  {
        return type_name_str<UnitTransform<T>>(false, namespace_separator) + "()";
    }

reverse()

template<class T >

T lsst::modelfit::parameters::UnitTransform< T >::reverse ( T x ) const

inlineoverridevirtual

Return the original value of x given a transformed value.

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

Definition at line 76 of file transform.h.

{ return x; }

str()

template<class T >

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

inlineoverridevirtual

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

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

Definition at line 72 of file transform.h.

{ return type_name_str<UnitTransform<T>>(true) + "()"; }

Member Data Documentation

CC_NAMESPACE_SEPARATOR

constexpr 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-9.0.0/Linux64/modelfit_parameters/g35bb328faa+34a971ddd9/include/lsst/modelfit/parameters/transform.h