FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kSpline.h
Go to the documentation of this file.
1 
9 #ifndef K_FIRESYNC_SPLINE_H
10 #define K_FIRESYNC_SPLINE_H
11 
12 #include <kFireSync/kFsDef.h>
13 
22 //typedef kObject kSpline; --forward-declared in kFsDef.x.h
23 
33 kFsFx(kStatus) kSpline_Construct(kSpline* spline, kSize knotCount, kAlloc allocator);
34 
43 kFsFx(k64f) kSpline_Apply(kSpline spline, k64f x);
44 
55 kFsFx(kStatus) kSpline_ApplyN(kSpline spline, const k64f* x, k64f* f, kSize count);
56 
69 kFsFx(kStatus) kSpline_SetDomain(kSpline spline, k64f xMin, k64f xMax);
70 
85 kFsFx(k64f*) kSpline_Coefficients(kSpline spline, kSize index);
86 
97 kFsFx(kSize) kSpline_KnotCount(kSpline spline);
98 
106 kFsFx(k64f*) kSpline_Knots(kSpline spline);
107 
115 kFsFx(k64f) kSpline_DomainMin(kSpline spline);
116 
124 kFsFx(k64f) kSpline_DomainMax(kSpline spline);
125 
143 kFsFx(kStatus) kSpline_Fit(kSpline spline, k32u order, const k64f* x, const k64f* f, kSize count);
144 
145 #include <kFireSync/Data/kSpline.x.h>
146 
147 #endif
148 
kSpline::kSpline_Coefficients
k64f * kSpline_Coefficients(kSpline spline, kSize index)
Gets the polynomial coefficients at the specified index.
kSpline::kSpline_DomainMax
k64f kSpline_DomainMax(kSpline spline)
Gets the user-defined maximum x-value for the spline.
kSpline::kSpline_Apply
k64f kSpline_Apply(kSpline spline, k64f x)
Calculates the output of the spline function for a single input value.
kSpline
Used to fit and apply splines.
kSpline::kSpline_Construct
kStatus kSpline_Construct(kSpline *spline, kSize knotCount, kAlloc allocator)
Constructs a kSpline object.
kFsDef.h
Essential API declarations for the kFireSync library.
kSpline::kSpline_Fit
kStatus kSpline_Fit(kSpline spline, k32u order, const k64f *x, const k64f *f, kSize count)
Generates spline coefficients for the given input data.
kSpline::kSpline_Knots
k64f * kSpline_Knots(kSpline spline)
Gets the x-values corresponding to the spline knots.
kSpline::kSpline_SetDomain
kStatus kSpline_SetDomain(kSpline spline, k64f xMin, k64f xMax)
Sets the valid domain for the spline.
kSpline::kSpline_ApplyN
kStatus kSpline_ApplyN(kSpline spline, const k64f *x, k64f *f, kSize count)
Calculates outputs of the spline function for an array of input values.
kSpline::kSpline_KnotCount
kSize kSpline_KnotCount(kSpline spline)
Reports the count of spline knots.
kSpline::kSpline_DomainMin
k64f kSpline_DomainMin(kSpline spline)
Gets the user-defined minimum x-value for the spline.