ConstantSpline Class Reference¶

Splines: Splines::ConstantSpline Class Reference

Splines

Picewise constants spline class. More...

#include <SplineConstant.hxx>

Inheritance diagram for Splines::ConstantSpline:

Public Member Functions
	ConstantSpline (string const &name="ConstantSpline")

	~ConstantSpline () override

void	reserve_external (integer n, real_type &p_x, real_type &p_y)
	Use externally allocated memory for `npts` points.

void	write_to_stream (ostream_type &) const override

SplineType1D	type () const override

void	reserve (integer npts) override

void	clear () override

integer	coeffs (real_type cfs[], real_type nodes[], bool transpose=false) const override

integer	order () const override

void	setup (GenericContainer const &gc) override

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

Build
void	build () override

void	build (real_type const x[], integer incx, real_type const y[], integer incy, integer n) override

Evaluate
real_type	eval (real_type x) const override
	Evalute spline value at `x`

real_type	D (real_type) const override

real_type	DD (real_type) const override

real_type	DDD (real_type) const override

Evaluation when segment is known
real_type	id_eval (integer ni, real_type x) const override
	Evalute spline value at `x`

real_type	id_D (integer, real_type) const override

real_type	id_DD (integer, real_type) const override

real_type	id_DDD (integer, real_type) const 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)

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

virtual real_type	DDDD (real_type) const

virtual real_type	DDDDD (real_type) 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

virtual real_type	id_DDDD (integer, real_type) const

virtual real_type	id_DDDDD (integer, real_type) const

char const *	type_name () const

string	info () const

void	info (ostream_type &stream) const

Detailed Description

Picewise constants spline class.

Constructor & Destructor Documentation

◆ ConstantSpline()

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

Build an empty spline of ConstantSpline type

Parameters

name	the name of the spline

◆ ~ConstantSpline()

Splines::ConstantSpline::~ConstantSpline ( )

inlineoverride

Spline destructor.

Member Function Documentation

◆ build() [1/2]

void Splines::ConstantSpline::build ( )

inlineoverridevirtual

Build the spline with the data stored

Implements Splines::Spline.

◆ build() [2/2]

void Splines::ConstantSpline::build	(	real_type const	x[],
		integer	incx,
		real_type const	y[],
		integer	incy,
		integer	n )

overridevirtual

Build the spline with the data passed as arguments

Parameters

x	\( x \) coordinates of the points
incx	access elements as `x[0]`, `x[incx]`, `x[2*incx]`,...
y	\( y \) coordinates of the points
incy	access elements as `y[0]`, `y[incx]`, `y[2*incx]`,...
n	the number of the points

Reimplemented from Splines::Spline.

◆ clear()

void Splines::ConstantSpline::clear ( )

overridevirtual

Delete the support points, empty the spline.

Implements Splines::Spline.

◆ coeffs()

integer Splines::ConstantSpline::coeffs	(	real_type	cfs[],
		real_type	nodes[],
		bool	transpose = false ) const

overridevirtual

get the piecewise polinomials of the spline

Implements Splines::Spline.

◆ D()

real_type Splines::ConstantSpline::D ( real_type x ) const

inlineoverridevirtual

First derivative

Implements Splines::Spline.

◆ DD()

real_type Splines::ConstantSpline::DD ( real_type x ) const

inlineoverridevirtual

Second derivative

Implements Splines::Spline.

◆ DDD()

real_type Splines::ConstantSpline::DDD ( real_type x ) const

inlineoverridevirtual

Third derivative

Implements Splines::Spline.

◆ eval()

real_type Splines::ConstantSpline::eval ( real_type x ) const

overridevirtual

Evalute spline value at x

Implements Splines::Spline.

◆ id_D()

real_type Splines::ConstantSpline::id_D	(	integer	ni,
		real_type	x ) const

inlineoverridevirtual

First derivative

Implements Splines::Spline.

◆ id_DD()

real_type Splines::ConstantSpline::id_DD	(	integer	ni,
		real_type	x ) const

inlineoverridevirtual

Second derivative

Implements Splines::Spline.

◆ id_DDD()

real_type Splines::ConstantSpline::id_DDD	(	integer	ni,
		real_type	x ) const

inlineoverridevirtual

Third derivative

Implements Splines::Spline.

◆ id_eval()

real_type Splines::ConstantSpline::id_eval	(	integer	ni,
		real_type	x ) const

overridevirtual

Evalute spline value at x

Implements Splines::Spline.

◆ order()

integer Splines::ConstantSpline::order ( ) const

overridevirtual

Spline order of the piecewise polynomial

Implements Splines::Spline.

◆ reserve()

void Splines::ConstantSpline::reserve ( integer npts )

overridevirtual

Allocate memory for npts points

Implements Splines::Spline.

◆ setup()

void Splines::ConstantSpline::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

Reimplemented from Splines::Spline.

◆ type()

SplineType1D Splines::ConstantSpline::type ( ) const

inlineoverridevirtual

spline type returned as integer

Implements Splines::Spline.

◆ write_to_stream()

void Splines::ConstantSpline::write_to_stream ( ostream_type & s ) const

overridevirtual

Print spline coefficients

Implements Splines::Spline.

◆ y_min_max() [1/2]

void Splines::ConstantSpline::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

overridevirtual

Search the max and min values of y along the spline with the corresponding x position

Parameters

[out]	i_min_pos	interval where is the minimum
[out]	x_min_pos	where is the minimum
[out]	y_min	the minimum value
[out]	i_max_pos	interval where is the maximum
[out]	x_max_pos	where is the maximum
[out]	y_max	the maximum value

Reimplemented from Splines::Spline.

◆ y_min_max() [2/2]

void Splines::ConstantSpline::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

overridevirtual

Search the max and min values of y along the spline with the corresponding x position

Parameters

[out]	i_min_pos	interval where is the minimum
[out]	x_min_pos	where is the minimum
[out]	y_min	the minimum value
[out]	i_max_pos	interval where is the maximum
[out]	x_max_pos	where is the maximum
[out]	y_max	the maximum value

Reimplemented from 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/SplineConstant.hxx
/Users/enrico/Ricerca/develop/PINS/pins-mechatronix/LibSources/submodules/Splines/src/SplineConstant.cc

ConstantSpline Class Reference¶

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ConstantSpline()

◆ ~ConstantSpline()

Member Function Documentation

◆ build() [1/2]

◆ build() [2/2]

◆ clear()

◆ coeffs()

◆ D()

◆ DD()

◆ DDD()

◆ eval()

◆ id_D()

◆ id_DD()

◆ id_DDD()

◆ id_eval()

◆ order()

◆ reserve()

◆ setup()

◆ type()

◆ write_to_stream()

◆ y_min_max() [1/2]

◆ y_min_max() [2/2]

Table of Contents

Search