SSAGES
0.9.3
Software Suite for Advanced General Ensemble Simulations
|
Defines the class of Legendre polynomials. More...
#include <Basis.h>
Public Member Functions | |
Legendre (unsigned int polyOrd, unsigned int nbins) | |
Constructor. More... | |
double | Evaluate (double x, int n) |
Calculates the output of the basis function. More... | |
double | EvalGrad (double x, int n) |
Calculates the gradient of the basis function. More... | |
double | GetNorm (int n) |
Gets the norm of the basis function. More... | |
Public Member Functions inherited from SSAGES::BasisFunction | |
BasisFunction (unsigned int polyOrd, unsigned int nbins, bool isFinite, bool zeroOrder, double boundLow, double boundUp) | |
Constructor. More... | |
unsigned int | GetOrder () |
Gets the order of the current polynomial. More... | |
unsigned int | GetBins () |
Gets the number of bins for the discretization. More... | |
bool | GetZeroOrder () |
Gets the flag for constant-order polynomials. More... | |
double | GetLower () |
Gets the lower bound on the CV. More... | |
double | GetUpper () |
Gets the upper bound on the CV. More... | |
double | GetRange () |
Gets the magnitude of the range of bounds. More... | |
virtual double | Weight (double) |
Calculates the weight of the basis function. More... | |
virtual | ~BasisFunction () |
Destructor. | |
Static Public Member Functions | |
static Legendre * | Build (const Json::Value &json, const std::string &path, unsigned int nbins) |
Build BasisFunction from JSON value. More... | |
Static Public Member Functions inherited from SSAGES::BasisFunction | |
static BasisFunction * | Build (const Json::Value &json, const std::string &path, unsigned int nbins) |
Build BasisFunction from JSON value. More... | |
Additional Inherited Members | |
Protected Attributes inherited from SSAGES::BasisFunction | |
unsigned int | polyOrd_ |
Order of the polynomial. | |
unsigned int | nbins_ |
Number of bins. | |
bool | isFinite_ |
Flag for finite-range polynomials. | |
bool | zeroOrder_ |
Flag for constant-order polynomials. | |
double | boundLow_ |
Lower bound on CV. | |
double | boundUp_ |
Upper bound on CV. | |
|
inline |
Constructor.
polyOrd | Order of Legendre polynomial. |
nbins | Number of bins. |
Constructs an instance of the Legendre function class.
Definition at line 269 of file Basis.h.
Referenced by Build().
|
static |
Build BasisFunction from JSON value.
Build the Legendre polynomial
Definition at line 75 of file Basis.cpp.
References Json::Requirement::GetErrors(), Json::Requirement::HasErrors(), Legendre(), Json::ObjectRequirement::Parse(), and Json::ObjectRequirement::Validate().
Referenced by SSAGES::BasisFunction::Build().
|
inlinevirtual |
Calculates the gradient of the basis function.
val | Input value for function. |
order | Order of the polynomial. |
Reimplemented from SSAGES::BasisFunction.
Definition at line 281 of file Basis.h.
References Evaluate().
|
inlinevirtual |
Calculates the output of the basis function.
val | Input value for function. |
order | Order of the polynomial. |
Reimplemented from SSAGES::BasisFunction.
Definition at line 274 of file Basis.h.
Referenced by EvalGrad().
|
inlinevirtual |
Gets the norm of the basis function.
order | Order of the polynomial. |
Reimplemented from SSAGES::BasisFunction.