LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | List of all members
lsst::geom::polynomials::Function1d< Basis_ > Class Template Reference

A 1-d function defined by a series expansion and its coefficients. More...

#include <Function1d.h>

Public Types

using iterator = double *
 
using const_iterator = double const *
 
using Basis = Basis_
 The basis type used by this function. More...
 

Public Member Functions

 Function1d (Basis const &basis)
 Construct with zero-valued coefficients. More...
 
 Function1d (Basis const &basis, Eigen::VectorXd const &coefficients)
 Construct with coefficients from an Eigen object. More...
 
template<typename Iterator >
 Function1d (Basis const &basis, Iterator first, Iterator last)
 Construct by copying coefficients from an STL iterator range. More...
 
 Function1d (Function1d const &)=default
 Default copy constructor. More...
 
 Function1d (Function1d &&)=default
 Default move constructor. More...
 
Function1doperator= (Function1d const &)=default
 Default copy assignment. More...
 
Function1doperator= (Function1d &&)=default
 Default move assignment. More...
 
iterator begin ()
 Iterators over coefficients. More...
 
iterator end ()
 
const_iterator cbegin () const
 
const_iterator cend () const
 
const_iterator begin () const
 
const_iterator end () const
 
Basis const & getBasis () const
 Return the associated Basis1d object. More...
 
std::size_t size () const
 Return the number of coefficients. More...
 
double operator() (double x, SumMode mode=SumMode::FAST) const
 Evaluate the function at the given point. More...
 
double & operator[] (std::size_t n)
 Return the coefficient associated with the nth basis function. More...
 
double const & operator[] (std::size_t n) const
 
auto getCoefficients ()
 Return the coefficient vector as an Eigen matrix-like object. More...
 
auto getCoefficients () const
 
Function1d< typename Basis::Scaled > scaled (Scaling1d const &scaling) const
 Return a new function that applies the given scaling to all points before evaluation. More...
 

Detailed Description

template<typename Basis_>
class lsst::geom::polynomials::Function1d< Basis_ >

A 1-d function defined by a series expansion and its coefficients.

A Function1d combines a Basis1d that defines basis functions \(B_n(x)\) with a vector of associated coefficients \(a_n\). Evaluating the function computes

\[ \sum_{n=0}^{n \le N} a_n B_n(x) \]

Definition at line 42 of file Function1d.h.

Member Typedef Documentation

◆ Basis

template<typename Basis_ >
using lsst::geom::polynomials::Function1d< Basis_ >::Basis = Basis_

The basis type used by this function.

Definition at line 49 of file Function1d.h.

◆ const_iterator

template<typename Basis_ >
using lsst::geom::polynomials::Function1d< Basis_ >::const_iterator = double const *

Definition at line 46 of file Function1d.h.

◆ iterator

template<typename Basis_ >
using lsst::geom::polynomials::Function1d< Basis_ >::iterator = double *

Definition at line 45 of file Function1d.h.

Constructor & Destructor Documentation

◆ Function1d() [1/5]

template<typename Basis_ >
lsst::geom::polynomials::Function1d< Basis_ >::Function1d ( Basis const &  basis)
inlineexplicit

Construct with zero-valued coefficients.

Definition at line 52 of file Function1d.h.

52  :
53  _basis(basis),
54  _coefficients(Eigen::VectorXd::Zero(basis.size()))
55  {}
table::Key< table::Array< double > > basis
Definition: PsfexPsf.cc:361

◆ Function1d() [2/5]

template<typename Basis_ >
lsst::geom::polynomials::Function1d< Basis_ >::Function1d ( Basis const &  basis,
Eigen::VectorXd const &  coefficients 
)
inline

Construct with coefficients from an Eigen object.

Definition at line 58 of file Function1d.h.

58  :
59  _basis(basis),
60  _coefficients(coefficients)
61  {
62  assert(basis.size() == static_cast<std::size_t>(_coefficients.size()));
63  }
ndarray::Array< double const, 2, 2 > coefficients

◆ Function1d() [3/5]

template<typename Basis_ >
template<typename Iterator >
lsst::geom::polynomials::Function1d< Basis_ >::Function1d ( Basis const &  basis,
Iterator  first,
Iterator  last 
)
inline

Construct by copying coefficients from an STL iterator range.

Definition at line 67 of file Function1d.h.

67  :
68  _basis(basis),
69  _coefficients(basis.size())
70  {
71  assert(std::distance(first, last) == static_cast<std::ptrdiff_t>(basis.size()));
72  std::copy(first, last, &_coefficients[0]);
73  }
T copy(T... args)
T distance(T... args)

◆ Function1d() [4/5]

template<typename Basis_ >
lsst::geom::polynomials::Function1d< Basis_ >::Function1d ( Function1d< Basis_ > const &  )
default

Default copy constructor.

◆ Function1d() [5/5]

template<typename Basis_ >
lsst::geom::polynomials::Function1d< Basis_ >::Function1d ( Function1d< Basis_ > &&  )
default

Default move constructor.

Member Function Documentation

◆ begin() [1/2]

template<typename Basis_ >
iterator lsst::geom::polynomials::Function1d< Basis_ >::begin ( )
inline

Iterators over coefficients.

Definition at line 89 of file Function1d.h.

89 { return _coefficients.data(); }

◆ begin() [2/2]

template<typename Basis_ >
const_iterator lsst::geom::polynomials::Function1d< Basis_ >::begin ( ) const
inline

Definition at line 93 of file Function1d.h.

93 { return _coefficients.data(); }

◆ cbegin()

template<typename Basis_ >
const_iterator lsst::geom::polynomials::Function1d< Basis_ >::cbegin ( ) const
inline

Definition at line 91 of file Function1d.h.

91 { return _coefficients.data(); }

◆ cend()

template<typename Basis_ >
const_iterator lsst::geom::polynomials::Function1d< Basis_ >::cend ( ) const
inline

Definition at line 92 of file Function1d.h.

92 { return begin() + size(); }
iterator begin()
Iterators over coefficients.
Definition: Function1d.h:89
std::size_t size() const
Return the number of coefficients.
Definition: Function1d.h:101

◆ end() [1/2]

template<typename Basis_ >
iterator lsst::geom::polynomials::Function1d< Basis_ >::end ( )
inline

Definition at line 90 of file Function1d.h.

90 { return begin() + size(); }

◆ end() [2/2]

template<typename Basis_ >
const_iterator lsst::geom::polynomials::Function1d< Basis_ >::end ( ) const
inline

Definition at line 94 of file Function1d.h.

94 { return begin() + size(); }

◆ getBasis()

template<typename Basis_ >
Basis const& lsst::geom::polynomials::Function1d< Basis_ >::getBasis ( ) const
inline

Return the associated Basis1d object.

Definition at line 98 of file Function1d.h.

98 { return _basis; }

◆ getCoefficients() [1/2]

template<typename Basis_ >
auto lsst::geom::polynomials::Function1d< Basis_ >::getCoefficients ( )
inline

Return the coefficient vector as an Eigen matrix-like object.

The exact type of the returned object is unspecified, but it is guaranteed to be a view.

Definition at line 125 of file Function1d.h.

125  {
126  // Return a block view to ensure the caller only modify the values, not the size.
127  return _coefficients.head(size());
128  }

◆ getCoefficients() [2/2]

template<typename Basis_ >
auto lsst::geom::polynomials::Function1d< Basis_ >::getCoefficients ( ) const
inline

Definition at line 129 of file Function1d.h.

129 { return _coefficients.head(size()); }

◆ operator()()

template<typename Basis_ >
double lsst::geom::polynomials::Function1d< Basis_ >::operator() ( double  x,
SumMode  mode = SumMode::FAST 
) const
inline

Evaluate the function at the given point.

Definition at line 104 of file Function1d.h.

104  {
105  return _basis.sumWith(x, _coefficients, mode);
106  }
double x

◆ operator=() [1/2]

template<typename Basis_ >
Function1d& lsst::geom::polynomials::Function1d< Basis_ >::operator= ( Function1d< Basis_ > &&  )
default

Default move assignment.

◆ operator=() [2/2]

template<typename Basis_ >
Function1d& lsst::geom::polynomials::Function1d< Basis_ >::operator= ( Function1d< Basis_ > const &  )
default

Default copy assignment.

◆ operator[]() [1/2]

template<typename Basis_ >
double& lsst::geom::polynomials::Function1d< Basis_ >::operator[] ( std::size_t  n)
inline

Return the coefficient associated with the nth basis function.

Caller is responsible for ensuring that the given index is valid.

Definition at line 114 of file Function1d.h.

114 { return begin()[n]; }

◆ operator[]() [2/2]

template<typename Basis_ >
double const& lsst::geom::polynomials::Function1d< Basis_ >::operator[] ( std::size_t  n) const
inline

Definition at line 115 of file Function1d.h.

115 { return begin()[n]; }

◆ scaled()

template<typename Basis_ >
Function1d<typename Basis::Scaled> lsst::geom::polynomials::Function1d< Basis_ >::scaled ( Scaling1d const &  scaling) const
inline

Return a new function that applies the given scaling to all points before evaluation.

Definition at line 133 of file Function1d.h.

133  {
134  return Function1d<typename Basis::Scaled>(getBasis().scaled(scaling), _coefficients);
135  }
table::Key< double > scaling
Function1d< typename Basis::Scaled > scaled(Scaling1d const &scaling) const
Return a new function that applies the given scaling to all points before evaluation.
Definition: Function1d.h:133
Basis const & getBasis() const
Return the associated Basis1d object.
Definition: Function1d.h:98

◆ size()

template<typename Basis_ >
std::size_t lsst::geom::polynomials::Function1d< Basis_ >::size ( ) const
inline

Return the number of coefficients.

Definition at line 101 of file Function1d.h.

101 { return _basis.size(); }

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