|
lsst.geom g096abc94f8+6a48825234
|
A 2-d function defined by a series expansion and its coefficients. More...
#include <Function2d.h>
Public Types | |
| using | iterator = double * |
| using | const_iterator = double const * |
| using | Basis = Basis_ |
| The basis type used by this function. More... | |
| using | Workspace = typename Basis::Workspace |
| Type returned by makeWorkspace(). More... | |
Public Member Functions | |
| Function2d (Basis const &basis) | |
| Construct with zero-valued coefficients. More... | |
| Function2d (Basis const &basis, Eigen::VectorXd const &coefficients) | |
| Construct with coefficients from an Eigen object. More... | |
| template<typename Iterator > | |
| Function2d (Basis const &basis, Iterator first, Iterator last) | |
| Construct by copying coefficients from an STL iterator range. More... | |
| Function2d (Function2d const &)=default | |
| Default copy constructor. More... | |
| Function2d (Function2d &&)=default | |
| Default move constructor. More... | |
| Function2d & | operator= (Function2d const &)=default |
| Default copy assignment. More... | |
| Function2d & | operator= (Function2d &&)=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 Basis2d object. More... | |
| std::size_t | size () const |
| Return the number of coefficients. More... | |
| Workspace | makeWorkspace () const |
| Allocate workspace that can be passed to operator() to avoid repeated memory allocations. More... | |
| double | operator() (geom::Point2D const &point, SumMode mode=SumMode::FAST) const |
| Evaluate the function at the given point. More... | |
| double | operator() (geom::Point2D const &point, Workspace &workspace, 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 |
| Function2d< typename Basis::Scaled > | scaled (Scaling2d const &scaling) const |
| Return a new function that applies the given scaling to all points before evaluation. More... | |
A 2-d function defined by a series expansion and its coefficients.
A Function1d combines a Basis2d that defines basis functions \(B_{n}(x, y)\) with a flattened vector of associated coefficients \(a_{n}\). The basis defines the order of coefficients. Evaluating the function computes
\[ \sum_{n}^{n \le N} a_{n} B_{n}(x, y) \]
Definition at line 42 of file Function2d.h.
| using lsst::geom::polynomials::Function2d< Basis_ >::Basis = Basis_ |
The basis type used by this function.
Definition at line 49 of file Function2d.h.
| using lsst::geom::polynomials::Function2d< Basis_ >::const_iterator = double const * |
Definition at line 46 of file Function2d.h.
| using lsst::geom::polynomials::Function2d< Basis_ >::iterator = double * |
Definition at line 45 of file Function2d.h.
| using lsst::geom::polynomials::Function2d< Basis_ >::Workspace = typename Basis::Workspace |
Type returned by makeWorkspace().
Definition at line 52 of file Function2d.h.
|
inlineexplicit |
Construct with zero-valued coefficients.
Definition at line 55 of file Function2d.h.
|
inlineexplicit |
Construct with coefficients from an Eigen object.
Definition at line 61 of file Function2d.h.
|
inlineexplicit |
Construct by copying coefficients from an STL iterator range.
Definition at line 70 of file Function2d.h.
|
default |
Default copy constructor.
|
default |
Default move constructor.
|
inline |
Iterators over coefficients.
Definition at line 92 of file Function2d.h.
|
inline |
Definition at line 96 of file Function2d.h.
|
inline |
Definition at line 94 of file Function2d.h.
|
inline |
Definition at line 95 of file Function2d.h.
|
inline |
Definition at line 93 of file Function2d.h.
|
inline |
Definition at line 97 of file Function2d.h.
|
inline |
Return the associated Basis2d object.
Definition at line 101 of file Function2d.h.
|
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 136 of file Function2d.h.
|
inline |
Definition at line 140 of file Function2d.h.
|
inline |
Allocate workspace that can be passed to operator() to avoid repeated memory allocations.
Definition at line 107 of file Function2d.h.
|
inline |
Evaluate the function at the given point.
Definition at line 110 of file Function2d.h.
|
inline |
Evaluate the function at the given point.
Definition at line 115 of file Function2d.h.
|
default |
Default move assignment.
|
default |
Default copy assignment.
|
inline |
Return the coefficient associated with the nth basis function.
Caller is responsible for ensuring that the given index is valid.
Definition at line 125 of file Function2d.h.
|
inline |
Definition at line 126 of file Function2d.h.
|
inline |
Return a new function that applies the given scaling to all points before evaluation.
Definition at line 144 of file Function2d.h.
|
inline |
Return the number of coefficients.
Definition at line 104 of file Function2d.h.