Darwin  1.10(beta)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Attributes | List of all members
drwnRegression Class Referenceabstract

Implements the interface for a generic machine learning regression, e.g. see drwnLinearRegressor. More...

Inheritance diagram for drwnRegression:
drwnStdObjIface drwnProperties drwnWriteable drwnCloneable drwnTypeable drwnLinearRegressorBase drwnTLinearRegressor< FeatureMap >

Public Member Functions

 drwnRegression ()
 default constructor
 
 drwnRegression (unsigned n)
 construct a regression object for data of dimension n
 
 drwnRegression (const drwnRegression &r)
 copy constructor
 
int numFeatures () const
 return the dimensionality of the feature space
 
virtual bool valid () const
 return true if the regressor has valid parameters (i.e., has been trained)
 
virtual void initialize (unsigned n)
 initialize the regressor to accept data of dimensionality n
 
virtual bool save (drwnXMLNode &xml) const
 write object to XML node (see also write)
 
virtual bool load (drwnXMLNode &xml)
 read object from XML node (see also read)
 
virtual double train (const drwnRegressionDataset &dataset)=0
 estimate the regression parameters a drwnRegressionDataset
 
virtual double train (const vector< vector< double > > &features, const vector< double > &targets)
 estimate the regression parameters a set of training examples
 
virtual double train (const vector< vector< double > > &features, const vector< double > &targets, const vector< double > &weights)
 estimate the regression parameters a set of weighted training examples
 
virtual double train (const char *filename)
 estimate the regression parameters from a drwnRegressionDataset file
 
virtual double getRegression (const vector< double > &features) const =0
 return the estimated value for a given feature vector
 
virtual void getRegressions (const vector< vector< double > > &features, vector< double > &outputTargets) const
 compute the estimated values for a set of feature vector and return the estimates in outputTargets
 
- Public Member Functions inherited from drwnWriteable
bool write (const char *filename) const
 write object to file (calls save)
 
bool read (const char *filename)
 read object from file (calls load)
 
void dump () const
 print object's current state to standard output (for debugging)
 
- Public Member Functions inherited from drwnTypeable
virtual const char * type () const =0
 returns object type as a string (e.g., Foo::type() { return "Foo"; })
 
- Public Member Functions inherited from drwnCloneable
virtual drwnCloneableclone () const =0
 returns a copy of the class usually implemented as virtual Foo* clone() { return new Foo(*this); }
 
- Public Member Functions inherited from drwnProperties
unsigned numProperties () const
 
bool hasProperty (const string &name) const
 
bool hasProperty (const char *name) const
 
unsigned findProperty (const string &name) const
 
unsigned findProperty (const char *name) const
 
void setProperty (unsigned indx, bool value)
 
void setProperty (unsigned indx, int value)
 
void setProperty (unsigned indx, double value)
 
void setProperty (unsigned indx, const string &value)
 
void setProperty (unsigned indx, const char *value)
 
void setProperty (unsigned indx, const Eigen::VectorXd &value)
 
void setProperty (unsigned indx, const Eigen::MatrixXd &value)
 
void setProperty (const char *name, bool value)
 
void setProperty (const char *name, int value)
 
void setProperty (const char *name, double value)
 
void setProperty (const char *name, const string &value)
 
void setProperty (const char *name, const char *value)
 
void setProperty (const char *name, const Eigen::VectorXd &value)
 
void setProperty (const char *name, const Eigen::MatrixXd &value)
 
string getPropertyAsString (unsigned indx) const
 
drwnPropertyType getPropertyType (unsigned indx) const
 
bool isReadOnly (unsigned indx) const
 
const drwnPropertyInterfacegetProperty (unsigned indx) const
 
const drwnPropertyInterfacegetProperty (const char *name) const
 
bool getBoolProperty (unsigned indx) const
 
int getIntProperty (unsigned indx) const
 
double getDoubleProperty (unsigned indx) const
 
const string & getStringProperty (unsigned indx) const
 
const list< string > & getListProperty (unsigned indx) const
 
int getSelectionProperty (unsigned indx) const
 
const Eigen::VectorXd & getVectorProperty (unsigned indx) const
 
const Eigen::MatrixXd & getMatrixProperty (unsigned indx) const
 
const string & getPropertyName (unsigned indx) const
 
vector< string > getPropertyNames () const
 
void readProperties (drwnXMLNode &xml, const char *tag="property")
 
void writeProperties (drwnXMLNode &xml, const char *tag="property") const
 
void printProperties (ostream &os) const
 

Protected Attributes

int _nFeatures
 number of features
 
bool _bValid
 true if regression parameters are trained or loaded
 

Additional Inherited Members

- Protected Member Functions inherited from drwnProperties
void declareProperty (const string &name, drwnPropertyInterface *optif)
 
void undeclareProperty (const string &name)
 
void exposeProperties (drwnProperties *opts, const string &prefix=string(""), bool bSerializable=false)
 
virtual void propertyChanged (const string &name)
 

Detailed Description

Implements the interface for a generic machine learning regression, e.g. see drwnLinearRegressor.


The documentation for this class was generated from the following files: