LSST Applications g063fba187b+cac8b7c890,g0f08755f38+6aee506743,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+b4475c5878,g1dcb35cd9c+8f9bc1652e,g20f6ffc8e0+6aee506743,g217e2c1bcf+73dee94bd0,g28da252d5a+1f19c529b9,g2bbee38e9b+3f2625acfc,g2bc492864f+3f2625acfc,g3156d2b45e+6e55a43351,g32e5bea42b+1bb94961c2,g347aa1857d+3f2625acfc,g35bb328faa+a8ce1bb630,g3a166c0a6a+3f2625acfc,g3e281a1b8c+c5dd892a6c,g3e8969e208+a8ce1bb630,g414038480c+5927e1bc1e,g41af890bb2+8a9e676b2a,g7af13505b9+809c143d88,g80478fca09+6ef8b1810f,g82479be7b0+f568feb641,g858d7b2824+6aee506743,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+2903d499ea,gb58c049af0+d64f4d3760,gc28159a63d+3f2625acfc,gcab2d0539d+b12535109e,gcf0d15dbbd+46a3f46ba9,gda6a2b7d83+46a3f46ba9,gdaeeff99f8+1711a396fd,ge79ae78c31+3f2625acfc,gef2f8181fd+0a71e47438,gf0baf85859+c1f95f4921,gfa517265be+6aee506743,gfa999e8aa5+17cd334064,w.2024.51
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
lsst::geom::polynomials::Basis1d Class Reference

A basis interface for 1-d series expansions. More...

#include <Basis1d.h>

Public Types

using Function = ...
 A Function1d object that uses this basis.
 
using Scaled = ...
 The type returned by scale().
 

Public Member Functions

std::size_t getOrder () const
 Return the order of the basis.
 
std::size_t size () const
 Return the number of elements in the basis.
 
Scaled scaled (Scaling1d const &scaling) const
 Return a scaled basis that delegates to a copy of this.
 
template<typename Vector >
double sumWith (double x, Vector const &coefficients) const
 Evaluate a basis expansion with the given coefficients.
 
template<typename Vector >
void fill (double x, Vector &&basis) const
 Evaluate the basis at a given point.
 

Detailed Description

A basis interface for 1-d series expansions.

Note
This class is only present in the documentation, as it represents an abstract interface for which C++ (prior to C++20, at least) has no language support. It may be formalized into a true Concept when that language feature is available.

Definition at line 36 of file Basis1d.h.

Member Typedef Documentation

◆ Function

A Function1d object that uses this basis.

Definition at line 40 of file Basis1d.h.

◆ Scaled

The type returned by scale().

Definition at line 43 of file Basis1d.h.

Member Function Documentation

◆ fill()

template<typename Vector >
void lsst::geom::polynomials::Basis1d::fill ( double x,
Vector && basis ) const

Evaluate the basis at a given point.

Parameters
[in]xPoint at which to evaluate the basis functions.
[out]basisOutput vector. May be any type for which coefficients[n] returns a non-const reference to a floating-point value. This includes std::vector<double>, ndarray::Array<double,1>, Eigen::VectorXd, Eigen view expressions, and mutable random access iterators.
Exception Safety
Does not throw unless coefficients[n] does, and provides basic exception safety if it does.

◆ getOrder()

std::size_t lsst::geom::polynomials::Basis1d::getOrder ( ) const

Return the order of the basis.

◆ scaled()

Scaled lsst::geom::polynomials::Basis1d::scaled ( Scaling1d const & scaling) const

Return a scaled basis that delegates to a copy of this.

The scaled basis will transform all points by the given scaling before evaluating the basis functions in the same way as this.

◆ size()

std::size_t lsst::geom::polynomials::Basis1d::size ( ) const

Return the number of elements in the basis.

◆ sumWith()

template<typename Vector >
double lsst::geom::polynomials::Basis1d::sumWith ( double x,
Vector const & coefficients ) const

Evaluate a basis expansion with the given coefficients.

If the basis elements are \(B_n(x)\) and the given coefficients are a vector \(a_n\), this computes

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

Parameters
[in]xPoint at which to evaluate the expansion.
[in]coefficientsCoefficients vector. May be any type for which coefficients[n] returns an object convertible to double for all n <= getOrder(). This includes std::vector<double>, ndarray::Array<double,1>, Eigen::VectorXd, and random access iterators. If a lazy expression template object is passed, the elements of the expression will be evaluated only once.
Exception Safety
Does not throw unless coefficients[n] does, and provides the same exception safety as it if it does.

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