Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   Related Pages  

rdGCVSplineSet Class Reference

A class for holding a set of generalized cross-validated splines. More...

#include <rdGCVSplineSet.h>

Inheritance diagram for rdGCVSplineSet:

rdFunctionSet rdObjectArray rdObject List of all members.

Public Member Functions

 rdGCVSplineSet ()
 Default constructor.

 rdGCVSplineSet (const char *aFileName)
 Construct a set of generalized cross-validated splines from file.

 rdGCVSplineSet (int aDegree, rdStorage *aStore, double aErrorVariance=0.0)
 Construct a set of generalized cross-validated splines based on the states stored in an rdStorage object.

virtual ~rdGCVSplineSet ()
 Destructor.

rdGCVSplinegetGCVSpline (int aIndex)
 Get the function at a specified index.

rdStorageconstructStorage (int aDerivOrder, double aDX=-1)
 Construct a storage object (see rdStorage) for this spline \ or for some derivative of this spline set.


Private Member Functions

void setNull ()
 Set all member variables to NULL values.

void construct (int aDegree, rdStorage *aStore, double aErrorVariance)
 Construct a set of generalized cross-validated splines based on the states stored in an rdStorage object.


Detailed Description

A class for holding a set of generalized cross-validated splines.

See also:
rdGCVSpline
Author:
Frank C. Anderson


Constructor & Destructor Documentation

rdGCVSplineSet::rdGCVSplineSet const char *  aFileName  ) 
 

Construct a set of generalized cross-validated splines from file.

Parameters:
aFileName Name of the file.

rdGCVSplineSet::rdGCVSplineSet int  aDegree,
rdStorage aStore,
double  aErrorVariance = 0.0
 

Construct a set of generalized cross-validated splines based on the states stored in an rdStorage object.

Each column in the rdStorage object is fit with a spline of the specified degree and is named the name of its corresponding column label. Note that column labels in the storage object are assumed to be tab delimited.

Parameters:
aDegree Degree of the constructed splines (1, 3, 5, or 7).
aStore Storage object.
aErrorVariance Estimate of the variance of the error in the data to be fit. If negative, the variance will be estimated. If 0.0, the fit will try to fit the data points exactly- no smoothing. If positive, the fits will be smoothed according to the specified variance. The larger the error veriance, the more the smoothing. Note that this is the error variance assumed for each column in the rdStorage. If different variances should be set for the various columns, you will need to construct each rdGCVSpline individually.
See also:
rdStorage

rdGCVSpline


Member Function Documentation

void rdGCVSplineSet::construct int  aDegree,
rdStorage aStore,
double  aErrorVariance
[private]
 

Construct a set of generalized cross-validated splines based on the states stored in an rdStorage object.

Parameters:
aDegree Degree of the constructed splines (1, 3, 5, or 7).
aStore Storage object.
aErrorVariance Error variance for the data.

rdStorage * rdGCVSplineSet::constructStorage int  aDerivOrder,
double  aDX = -1
 

Construct a storage object (see rdStorage) for this spline \ or for some derivative of this spline set.

Parameters:
aDerivOrder Derivative order. 0 constructs from the spline, 1 constructs from the first derivative of the spline, 2 constructs from the second derivative of the spline, etc.
aDX Spacing of the data points in the independent variable. If negative the spacing of the independent variable is taken from the original data, as determined from the first non-NULL spline in the set. aDX has a default value of -1.
Returns:
Storage object. If a valid storage object cannot be constructed NULL is returned.
See also:
rdStorage

rdGCVSpline * rdGCVSplineSet::getGCVSpline int  aIndex  ) 
 

Get the function at a specified index.

Parameters:
aIndex Index of the desired function: 0 <= aIndex < getFirstEmpty().
Returns:
Function at index aIndex. If aIndex is not value NULL is returned.


The documentation for this class was generated from the following files:
Generated on Wed Aug 20 02:17:10 2003 for Simulation Software by doxygen1.3