SG++-Doxygen-Documentation
sgpp::base::ModBsplineGrid Class Reference

Grid with modified Bspline basis functions. More...

#include <ModBsplineGrid.hpp>

Inheritance diagram for sgpp::base::ModBsplineGrid:
sgpp::base::Grid

Public Member Functions

SBasisgetBasis () override
 
virtual size_t getDegree ()
 
GridGeneratorgetGenerator () override
 Creates new GridGenerator This must be changed if we add other storage types. More...
 
sgpp::base::GridType getType () override
 
 ModBsplineGrid (size_t dim, size_t degree)
 Constructor of grid with modified bspline basis functions. More...
 
void serialize (std::ostream &ostr, int version=SERIALIZATION_VERSION) override
 Serializes the grid. More...
 
 ~ModBsplineGrid () override
 Destructor. More...
 
- Public Member Functions inherited from sgpp::base::Grid
Gridclone ()
 copies a grid More...
 
GridcreateGridOfEquivalentType (size_t numDims)
 creates an equivalent grid without copying the grid points More...
 
std::vector< size_t > getAlgorithmicDimensions ()
 returns the algorithmic dimensions (the dimensions in which the Up Down operations should be applied) More...
 
virtual BoundingBoxgetBoundingBox ()
 gets a reference to the GridStorage's BoundingsBox object More...
 
size_t getDimension () const
 Returns the number of dimensions. More...
 
size_t getSize () const
 Returns the number of points on the grid. More...
 
virtual GridStoragegetStorage ()
 gets a reference to the GridStorage object More...
 
virtual StretchinggetStretching ()
 gets a reference to the GridStorage's Stretching object More...
 
std::string getTypeAsString ()
 Returns a string that identifies the grid type uniquely. More...
 
sgpp::base::GridType getZeroBoundaryType ()
 Returns the grid type that corresponds to the actual type but does no boundary treatment. More...
 
 Grid (const Grid &other)=delete
 delete copy constructor More...
 
void insertPoint (size_t dim, unsigned int levels[], unsigned int indices[], bool isLeaf)
 Insert one point to the grid. More...
 
void refine (DataVector &vector, int numOfPoints)
 Refine grid Refine the given number of points on the grid according to the vector. More...
 
void serialize (std::string &ostr, int version=SERIALIZATION_VERSION)
 Serializes grid to a string. More...
 
std::string serialize (int version=SERIALIZATION_VERSION)
 Serializes grid to a string. More...
 
void setAlgorithmicDimensions (std::vector< size_t > newAlgoDims)
 sets the algorithmic dimensions (the dimensions in which the Up Down operations should be applied) More...
 
virtual void setBoundingBox (BoundingBox &boundingBox)
 sets the GridStorage's BoundingsBox pointer to a BoundingBox object More...
 
virtual void setStretching (Stretching &stretching)
 sets the GridStorage's Stretching pointer to a Stretching object More...
 
virtual ~Grid ()
 Desctructor. More...
 

Static Public Member Functions

static Gridunserialize (std::istream &istr)
 reads a grid out of a string More...
 
- Static Public Member Functions inherited from sgpp::base::Grid
static GridcreateBsplineBoundaryGrid (size_t dim, size_t degree)
 creates a B-spline trapezoid boundary grid More...
 
static GridcreateBsplineClenshawCurtisGrid (size_t dim, size_t degree)
 creates a B-spline Clenshaw-Curtis grid More...
 
static GridcreateBsplineGrid (size_t dim, size_t degree)
 creates a B-spline grid More...
 
static GridcreateFundamentalSplineGrid (size_t dim, size_t degree)
 creates a fundamental spline grid More...
 
static GridcreateGrid (RegularGridConfiguration gridConfig)
 creates a grid defined by the grid configuration More...
 
static GridcreateLinearBoundaryGrid (size_t dim, level_t boundaryLevel=1)
 creates a linear boundary grid More...
 
static GridcreateLinearClenshawCurtisBoundaryGrid (size_t dim, level_t boundaryLevel=1)
 creates a linear Clenshaw-Curtis boundary grid More...
 
static GridcreateLinearClenshawCurtisGrid (size_t dim)
 creates a linear Clenshaw-Curtis grid More...
 
static GridcreateLinearGrid (size_t dim)
 Creates and returns a grid without grid points on the boundary (zero boundary conditions) with piecewise linear basis functions. More...
 
static GridcreateLinearGridStencil (size_t dim)
 creates a stencil for a linear grid (without boundaries) More...
 
static GridcreateLinearStretchedBoundaryGrid (size_t dim)
 creates a linearstretched truncated boundary grid More...
 
static GridcreateLinearStretchedGrid (size_t dim)
 creates a linear stretched grid without boundaries More...
 
static GridcreateLinearTruncatedBoundaryGrid (size_t dim)
 creates a truncated boundary grid=contains all the gridpoints of the fullgrids which have \(|l|<level and li>=l_user\) More...
 
static GridcreateModBsplineClenshawCurtisGrid (size_t dim, size_t degree)
 creates a modified B-spline Clenshaw-Curtis grid More...
 
static GridcreateModBsplineGrid (size_t dim, size_t degree)
 creates a modified B-spline grid More...
 
static GridcreateModFundamentalSplineGrid (size_t dim, size_t degree)
 creates a modified fundamental spline grid More...
 
static GridcreateModLinearClenshawCurtisGrid (size_t dim)
 creates a modified linear Clenshaw-Curtis grid More...
 
static GridcreateModLinearGrid (size_t dim)
 creates a modified linear grid More...
 
static GridcreateModLinearGridStencil (size_t dim)
 creates a stencil for a modified linear grid (without boundaries) More...
 
static GridcreateModPolyClenshawCurtisGrid (size_t dim, size_t degree)
 creates a modified poly grid with clenshaw curtis points More...
 
static GridcreateModPolyGrid (size_t dim, size_t degree)
 creates a modified polynomial grid More...
 
static GridcreateModWaveletGrid (size_t dim)
 creates a modified wavelet grid More...
 
static GridcreateNakBsplineBoundaryCombigridGrid (size_t dim, size_t degree)
 creates a not a knot B-Spline boundary grid More...
 
static GridcreatePeriodicGrid (size_t dim)
 creates a periodic grid More...
 
static GridcreatePolyBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a polynomial grid with truncated boundary More...
 
static GridcreatePolyClenshawCurtisBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a poly Clenshaw Curtis boundary grid with clenshaw curtis points More...
 
static GridcreatePolyClenshawCurtisGrid (size_t dim, size_t degree)
 creates a poly grid with clenshaw curtis points More...
 
static GridcreatePolyGrid (size_t dim, size_t degree)
 creates a polynomial grid More...
 
static GridcreatePrewaveletGrid (size_t dim)
 creates a prewavelet grid More...
 
static GridcreateSquareRootGrid (size_t dim)
 creates a square root grid (h-grid) More...
 
static GridcreateWaveletBoundaryGrid (size_t dim)
 creates a wavelet trapezoid boundary grid More...
 
static GridcreateWaveletGrid (size_t dim)
 creates a wavelet grid More...
 
static GridType stringToGridType (const std::string &gridType)
 Conversion from string to grid type. More...
 
static Gridunserialize (const std::string &istr)
 reads a grid out of a string More...
 
static Gridunserialize (std::istream &istr)
 reads a grid out of a stream More...
 

Protected Member Functions

 ModBsplineGrid (std::istream &istr)
 This constructor creates a new GridStorage out of the stream. More...
 
- Protected Member Functions inherited from sgpp::base::Grid
 Grid (std::istream &istr)
 This constructor creates a new GridStorage out of the stream. More...
 
 Grid (size_t dim)
 Constructor initializing the grid storage with the given dimensionality. More...
 
 Grid (BoundingBox &boundingBox)
 Constructor initializing the grid storage with the given BoundingBox. More...
 
 Grid (Stretching &stretching)
 Constructor initializing the grid storage with the given Stretching. More...
 

Protected Attributes

std::unique_ptr< SBsplineModifiedBasebasis_
 B-spline basis. More...
 
size_t degree
 B-spline degree. More...
 
StandardGridGenerator generator
 grid generator More...
 
- Protected Attributes inherited from sgpp::base::Grid
GridStorage storage
 GridStorage object of the grid. More...
 

Additional Inherited Members

- Protected Types inherited from sgpp::base::Grid
typedef Grid *(* Factory) (std::istream &)
 
typedef std::map< std::string, Grid::FactoryfactoryMap
 
typedef std::map< sgpp::base::GridType, std::string > gridTypeVerboseMap
 
- Static Protected Member Functions inherited from sgpp::base::Grid
static GridnullFactory (std::istream &)
 Factory for everything we don't know. More...
 

Detailed Description

Grid with modified Bspline basis functions.

Constructor & Destructor Documentation

◆ ModBsplineGrid() [1/2]

sgpp::base::ModBsplineGrid::ModBsplineGrid ( std::istream &  istr)
explicitprotected

This constructor creates a new GridStorage out of the stream.

Parameters
istrinputstream that contains the grid information

References basis_, and degree.

Referenced by unserialize().

◆ ModBsplineGrid() [2/2]

sgpp::base::ModBsplineGrid::ModBsplineGrid ( size_t  dim,
size_t  degree 
)
explicit

Constructor of grid with modified bspline basis functions.

Parameters
dimthe dimension of the grid
degreethe bspline's degree

◆ ~ModBsplineGrid()

sgpp::base::ModBsplineGrid::~ModBsplineGrid ( )
override

Destructor.

Member Function Documentation

◆ getBasis()

SBasis & sgpp::base::ModBsplineGrid::getBasis ( )
overridevirtual
Returns
B-spline basis

Implements sgpp::base::Grid.

References basis_.

◆ getDegree()

size_t sgpp::base::ModBsplineGrid::getDegree ( )
virtual

◆ getGenerator()

GridGenerator & sgpp::base::ModBsplineGrid::getGenerator ( )
overridevirtual

Creates new GridGenerator This must be changed if we add other storage types.

Returns
pointer to a GridGenerator object

Implements sgpp::base::Grid.

References generator.

◆ getType()

sgpp::base::GridType sgpp::base::ModBsplineGrid::getType ( )
overridevirtual
Returns
string that identifies the grid type uniquely

Implements sgpp::base::Grid.

References sgpp::base::ModBspline.

◆ serialize()

◆ unserialize()

Grid * sgpp::base::ModBsplineGrid::unserialize ( std::istream &  istr)
static

reads a grid out of a string

Parameters
istrstring that contains the grid information
Returns
grid

References ModBsplineGrid().

Referenced by sgpp::base::Grid::unserialize().

Member Data Documentation

◆ basis_

std::unique_ptr<SBsplineModifiedBase> sgpp::base::ModBsplineGrid::basis_
protected

B-spline basis.

Referenced by getBasis(), and ModBsplineGrid().

◆ degree

size_t sgpp::base::ModBsplineGrid::degree
protected

B-spline degree.

Referenced by getDegree(), ModBsplineGrid(), and serialize().

◆ generator

StandardGridGenerator sgpp::base::ModBsplineGrid::generator
protected

grid generator

Referenced by getGenerator().


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