lsst.modelfit.parameters g35bb328faa+b0138be388
 
Loading...
Searching...
No Matches
lsst::modelfit::parameters::Transform< T > Class Template Referenceabstract

A reversible transformation of a real scalar value. More...

#include <transform.h>

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

Public Member Functions

virtual std::string description () const =0
 Return a description of this transform.
 
virtual T derivative (T x) const =0
 Return the derivative of this tranform at the value x.
 
virtual T forward (T x) const =0
 Return the transformed value of x.
 
virtual T reverse (T x) const =0
 Return the original value of x given a transformed value.
 
- Public Member Functions inherited from lsst::modelfit::parameters::Object
virtual std::string repr (bool name_keywords=false, const std::string_view &namespace_separator=CC_NAMESPACE_SEPARATOR) const =0
 
virtual std::string str () const =0
 Return a brief, human-readable string representation of this.
 

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<class T>
class lsst::modelfit::parameters::Transform< T >

A reversible transformation of a real scalar value.

The transformation should be differentiable, ideally analytically.

Template Parameters
TThe type of the value. Only floating point values are tested.

Member Function Documentation

◆ derivative()

template<class T>
virtual T lsst::modelfit::parameters::Transform< T >::derivative ( T x) const
pure virtual

Return the derivative of this tranform at the value x.

Implemented in lsst::modelfit::parameters::UnitTransform< T >.

◆ description()

template<class T>
virtual std::string lsst::modelfit::parameters::Transform< T >::description ( ) const
pure virtual

Return a description of this transform.

Implemented in lsst::modelfit::parameters::UnitTransform< T >.

◆ forward()

template<class T>
virtual T lsst::modelfit::parameters::Transform< T >::forward ( T x) const
pure virtual

Return the transformed value of x.

Implemented in lsst::modelfit::parameters::UnitTransform< T >.

◆ reverse()

template<class T>
virtual T lsst::modelfit::parameters::Transform< T >::reverse ( T x) const
pure virtual

Return the original value of x given a transformed value.

Implemented in lsst::modelfit::parameters::UnitTransform< T >.


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