Splines

#include <SplineCubic.hxx>

Inheritance diagram for Splines::CubicSpline:

Public Member Functions
SplineType1D	type () const override
Constructors
	CubicSpline (string const &name="CubicSpline")
	~CubicSpline () override
Setup
void	set_initial_BC (CubicSpline_BC bc0)
void	set_final_BC (CubicSpline_BC bcn)
void	build () override
void	setup (GenericContainer const &gc) override
Public Member Functions inherited from Splines::CubicSplineBase
void	copy_spline (CubicSplineBase const &S)
real_type	yp_node (integer i) const
void	set_range (real_type xmin, real_type xmax)
void	reserve_external (integer n, real_type *&p_x, real_type *&p_y, real_type *&p_dy)
void	y_min_max (integer &i_min_pos, real_type &x_min_pos, real_type &y_min, integer &i_max_pos, real_type &x_max_pos, real_type &y_max) const override
void	y_min_max (vector< integer > &i_min_pos, vector< real_type > &x_min_pos, vector< real_type > &y_min, vector< integer > &i_max_pos, vector< real_type > &x_max_pos, vector< real_type > &y_max) const override
void	write_to_stream (ostream_type &s) const override
void	clear () override
integer	coeffs (real_type cfs[], real_type nodes[], bool transpose=false) const override
integer	order () const override
	CubicSplineBase (string const &name="CubicSplineBase")
real_type	eval (real_type x) const override
real_type	D (real_type x) const override
real_type	DD (real_type x) const override
real_type	DDD (real_type x) const override
real_type	DDDD (real_type) const override
real_type	DDDDD (real_type) const override
real_type	id_eval (integer ni, real_type x) const override
real_type	id_D (integer ni, real_type x) const override
real_type	id_DD (integer ni, real_type x) const override
real_type	id_DDD (integer ni, real_type x) const override
real_type	id_DDDD (integer, real_type) const override
real_type	id_DDDDD (integer, real_type) const override
void	build (real_type const x[], integer incx, real_type const y[], integer incy, real_type const yp[], integer incyp, integer n)
void	build (real_type const x[], real_type const y[], real_type const yp[], integer n)
void	build (vector< real_type > const &x, vector< real_type > const &y, vector< real_type > const &yp)
void	reserve (integer npts) override
Public Member Functions inherited from Splines::Spline
void	search (std::pair< integer, real_type > &res) const
	Spline (string const &name="Spline")
virtual	~Spline ()
string const &	name () const
bool	is_closed () const
void	make_closed ()
void	make_opened ()
bool	is_bounded () const
void	make_unbounded ()
void	make_bounded ()
bool	is_extended_constant () const
void	make_extended_constant ()
void	make_extended_not_constant ()
integer	num_points () const
real_type	x_node (integer i) const
real_type	y_node (integer i) const
real_type	x_begin () const
real_type	y_begin () const
real_type	x_end () const
real_type	y_end () const
real_type	x_min () const
real_type	x_max () const
real_type	y_min () const
real_type	y_max () const
void	build (GenericContainer const &gc)
virtual void	build (real_type const x[], integer incx, real_type const y[], integer incy, integer n)
void	build (real_type const x[], real_type const y[], integer n)
void	build (vector< real_type > const &x, vector< real_type > const &y)
void	push_back (real_type x, real_type y)
void	drop_back ()
void	set_origin (real_type x0)
void	set_range (real_type xmin, real_type xmax)
void	dump (ostream_type &s, integer nintervals, char const header[]="x\ty") const
void	dump (char const fname[], integer nintervals, char const header[]="x\ty") const
real_type	operator() (real_type x) const
real_type	eval_D (real_type x) const
real_type	eval_DD (real_type x) const
real_type	eval_DDD (real_type x) const
real_type	eval_DDDD (real_type x) const
real_type	eval_DDDDD (real_type x) const
char const *	type_name () const
string	info () const
void	info (ostream_type &stream) const

Detailed Description

Cubic Spline Management Class

Constructor & Destructor Documentation

CubicSpline()

Splines::CubicSpline::CubicSpline ( string const & name = "CubicSpline" )

inline

Build an empty spline of CubicSpline type

Parameters

name	the name of the spline

~CubicSpline()

Splines::CubicSpline::~CubicSpline ( )

inlineoverride

Spline destructor.

Member Function Documentation

build()

void Splines::CubicSpline::build ( )

overridevirtual

Build a spline using internal stored data

Implements Splines::Spline.

set_final_BC()

void Splines::CubicSpline::set_final_BC ( CubicSpline_BC bcn )

inline

Set the boudary consition for final point

Parameters

[in]

bcn

final boundary condition.

set_initial_BC()

void Splines::CubicSpline::set_initial_BC ( CubicSpline_BC bc0 )

inline

Set the boudary consition for initial point

Parameters

[in]

bc0

initial boundary condition.

setup()

void Splines::CubicSpline::setup ( GenericContainer const & gc )

overridevirtual

Setup a spline using a GenericContainer

• gc("xdata") vector with the x coordinate of the data
• gc("ydata") vector with the y coordinate of the data

may contain

• gc("bc_begin") and/or gc("bc_end")
  • "extrapolate" extrapolate the boundary condition
  • "natural" make second derivative 0 at the border
  • "parabolic" make third derivative 0 at the border
  • "not_a_knot" not a knot condition of De Boor

Reimplemented from Splines::Spline.

type()

SplineType1D Splines::CubicSpline::type ( ) const

inlineoverridevirtual

Return spline type (as number)

Implements Splines::Spline.

---

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

• /Users/enrico/Ricerca/develop/PINS/pins-mechatronix/LibSources/submodules/Splines/src/Splines/SplineCubic.hxx
• /Users/enrico/Ricerca/develop/PINS/pins-mechatronix/LibSources/submodules/Splines/src/SplineCubic.cc