SplineSet Class ReferenceΒΆ
|
Splines
|
SplineSet Class Reference
Inheritance diagram for SplineSet:
Public Member Functions | |
| function | SplineSet (in varargin) |
| function | build (in self, in kinds, in x, in y) |
| function | eval (in self, in x) |
| function | eval_D (in self, in x) |
| function | eval_DD (in self, in x) |
| function | eval_DDD (in self, in x) |
| function | tmin (in self, in x) |
| function | tmax (in self, in x) |
Protected Member Functions | |
| function | copyElement (in self) |
Detailed Description
MATLAB class wrapper for the underlying C++ class
Constructor & Destructor Documentation
◆ SplineSet()
| function SplineSet::SplineSet | ( | in | varargin | ) |
Build a spline Set
X = [ .... ]; % vector or nodes
Y = [ .... ]; % matrix of values or
Y = { [....], ...., [....] }; % cell array of vectors
kind = { .... } % cell array of strings
% with the kind of each spline
obj = SplineSet( kind, X, Y );
Kind is a string and can be any of
| kind | meaning |
|---|---|
| 'linear' | linear spline (only continuous) |
| 'cubic' | cubic spline ( \( C^2 \) function) |
| 'akima' | Akima non oscillatory spline ( \( C^1 \) function) |
| 'bessel' | bessel non oscillatory spline ( \( C^1 \) function) |
| 'pchip' | Monotone \( C^1 \) function |
| 'hermite' | Hermite spline (set \( p_k \) and \( p'_k \)) |
| 'quintic' | Quintic spline ( \( C^3 \) function) |
Member Function Documentation
◆ build()
| function SplineSet::build | ( | in | self, |
| in | kinds, | ||
| in | x, | ||
| in | y ) |
Build a spline Set
obj = SplineSet( kind, X, Y );
◆ copyElement()
|
protected |
Make a deep copy of a curve object
Usage
B = A.copy();
where A is the curve object to be copied.
◆ eval()
| function SplineSet::eval | ( | in | self, |
| in | x ) |
Evaluate spline at x
p = obj.eval( x );
◆ eval_D()
| function SplineSet::eval_D | ( | in | self, |
| in | x ) |
Evaluate spline derivative at x
p_D = obj.eval_D( x );
◆ eval_DD()
| function SplineSet::eval_DD | ( | in | self, |
| in | x ) |
Evaluate spline second derivative at x
p_DD = obj.eval_DD( x );
◆ eval_DDD()
| function SplineSet::eval_DDD | ( | in | self, |
| in | x ) |
Evaluate spline third derivative at x
p_DDD = obj.eval_DDD( x );
◆ tmax()
| function SplineSet::tmax | ( | in | self, |
| in | x ) |
Return initial t-coordinate of the spline
t = obj.tmax();
◆ tmin()
| function SplineSet::tmin | ( | in | self, |
| in | x ) |
Return initial t-coordinate of the spline
t = obj.tmin();
The documentation for this class was generated from the following file:
- /Users/enrico/Ricerca/develop/PINS/pins-mechatronix/LibSources/submodules/Splines/toolbox/lib/SplineSet.m
Generated by