Header menu logo FSharp.Stats

CubicSplineCoef Type

Namespace: FSharp.Stats
Assembly: FSharp.Stats.dll
Parent Module: CubicSpline
Base Type: obj
All Interfaces: IEquatable<CubicSplineCoef> , IStructuralEquatable , IComparable<CubicSplineCoef> , IComparable , IStructuralComparable

Contains x data, y data (c0), slopes (c1), curvatures (c2), and the third derivative at each knot

Record fields

Record Field Description

C0_3

Full Usage: C0_3

Field type: Vector<float>

vector of [a0;b0;c0;d0;a1;b1;...;d(n-2)] where f_n(x) = (an)x^3 + (bn)x^2 + (cn)x + (dn)

Field type: Vector<float>

XData

Full Usage: XData

Field type: Vector<float>
Field type: Vector<float>

Instance members

Instance member Description

this.Predict

Full Usage: this.Predict

Returns: float -> float Function that takes an x value and returns function value.

Returns function that takes x value and predicts the corresponding interpolating y value.

x values outside of the xValue range are predicted by straight lines defined by the nearest knot!

Returns: float -> float

Function that takes an x value and returns function value.

Example 

 
 // e.g. days since a certain event
 let xData = vector [|0.;1.;5.;4.;3.;|]
 // some measured feature
 let yData = vector [|1.;5.;4.;13.;17.|]
 
 // get coefficients for piecewise interpolating cubic polynomials
 let coefficients = 
     CubicSpline.interpolate CubicSpline.BoundaryConditions.Natural xData yData

 // get function value at x=3.4
 coefficients.Predict 3.4
val xData: obj
val yData: obj
val coefficients: obj

this.PredictWithinRange

Full Usage: this.PredictWithinRange

Returns: float -> float Function that takes an x value and returns function value.

Returns function that takes x value (that lies within the range of input x values) and predicts the corresponding interpolating y value.

Only defined within the range of the given xValues!

Returns: float -> float

Function that takes an x value and returns function value.

Example 

 
 // e.g. days since a certain event
 let xData = vector [|0.;1.;5.;4.;3.;|]
 // some measured feature
 let yData = vector [|1.;5.;4.;13.;17.|]
 
 // get coefficients for piecewise interpolating cubic polynomials
 let coefficients = 
     CubicSpline.interpolate CubicSpline.BoundaryConditions.Natural xData yData

 // get function value at x=3.4
 coefficients.PredictWithinRange 3.4
val xData: obj
val yData: obj
val coefficients: obj

Static members

Static member Description

CubicSplineCoef.Create(x) (c)

Full Usage: CubicSplineCoef.Create(x) (c)

Parameters:
    x : Vector<float>
    c : Vector<float>

Returns: CubicSplineCoef
x : Vector<float>
c : Vector<float>
Returns: CubicSplineCoef

Type something to start searching.