BALL  1.4.79
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members
BALL::QSAR::LinearModel Class Reference

#include <BALL/QSAR/linearModel.h>

Inheritance diagram for BALL::QSAR::LinearModel:
BALL::QSAR::RegressionModel BALL::QSAR::Model BALL::QSAR::MLRModel BALL::QSAR::PCRModel BALL::QSAR::PLSModel BALL::QSAR::RRModel BALL::QSAR::OPLSModel

Public Member Functions

Constructors and Destructors
 LinearModel (const QSARData &q)
 
 ~LinearModel ()
 
virtual void operator= (const LinearModel &m)
 
- Public Member Functions inherited from BALL::QSAR::RegressionModel
 RegressionModel (const QSARData &q)
 
 ~RegressionModel ()
 
virtual
EIGEN_MAKE_ALIGNED_OPERATOR_NEW
void 
operator= (const RegressionModel &m)
 
const Eigen::MatrixXd * getTrainingResult () const
 
virtual void saveToFile (string filename)
 
virtual void readFromFile (string filename)
 
void show ()
 
- Public Member Functions inherited from BALL::QSAR::Model
 Model (const QSARData &q)
 
virtual ~Model ()
 
virtual void operator= (const Model &m)
 
void copyData (const Model &m)
 
void copyDescriptorIDs (const Model &m)
 
void readTrainingData ()
 
void deleteDescriptorIDs ()
 
virtual void train ()=0
 
virtual bool optimizeParameters (int, int)
 
bool optimizeParameters (int k)
 
virtual double calculateStdErr ()
 
virtual void setParameters (vector< double > &)
 
virtual vector< doublegetParameters () const
 
std::multiset< unsigned int > * getDescriptorIDs ()
 
void setDataSource (const QSARData *q)
 
const Eigen::MatrixXd * getDescriptorMatrix ()
 
const vector< string > * getSubstanceNames ()
 
const vector< string > * getDescriptorNames ()
 
const Eigen::MatrixXd getDescriptorTransformations ()
 
const Eigen::MatrixXd getYTransformations ()
 
const Eigen::MatrixXd * getY ()
 
void setDescriptorIDs (const std::multiset< unsigned int > &sl)
 
const string * getType ()
 
void getUnnormalizedFeatureValue (int compound, int feature, double &return_value)
 
void getUnnormalizedResponseValue (int compound, int response, double &return_value)
 

Accessors

virtual Eigen::VectorXd predict (const vector< double > &substance, bool transform=1)
 
void calculateOffsets ()
 

Additional Inherited Members

- Public Attributes inherited from BALL::QSAR::RegressionModel
RegressionValidationvalidation
 
- Public Attributes inherited from BALL::QSAR::Model
const QSARDatadata
 
Validationmodel_val
 
- Protected Member Functions inherited from BALL::QSAR::RegressionModel
void readDescriptorInformationFromFile (std::ifstream &in, int no_descriptors, bool transformation, int no_coefficients)
 
void saveDescriptorInformationToFile (std::ofstream &out)
 
- Protected Member Functions inherited from BALL::QSAR::Model
void readMatrix (Eigen::MatrixXd &mat, std::ifstream &in, unsigned int lines, unsigned int col)
 
void readVector (Eigen::RowVectorXd &vec, std::ifstream &in, unsigned int no_cells, bool column_vector)
 
void readModelParametersFromFile (std::ifstream &in)
 
void saveModelParametersToFile (std::ofstream &out)
 
virtual void readDescriptorInformationFromFile (std::ifstream &in, int no_descriptors, bool transformation)
 
void readResponseTransformationFromFile (std::ifstream &in, int no_y)
 
void saveResponseTransformationToFile (std::ofstream &out)
 
Eigen::VectorXd getSubstanceVector (const vector< double > &substance, bool transform)
 
Eigen::VectorXd getSubstanceVector (const Eigen::VectorXd &substance, bool transform)
 
void backTransformPrediction (Eigen::VectorXd &pred)
 
void addLambda (Eigen::MatrixXd &matrix, double &lambda)
 
void readDescriptorInformation ()
 
- Protected Attributes inherited from BALL::QSAR::RegressionModel
Eigen::MatrixXd training_result_
 
Eigen::RowVectorXd offsets_
 
- Protected Attributes inherited from BALL::QSAR::Model
int default_no_opt_steps_
 
Eigen::MatrixXd descriptor_matrix_
 
vector< string > substance_names_
 
vector< string > descriptor_names_
 
Eigen::MatrixXd descriptor_transformations_
 
Eigen::MatrixXd y_transformations_
 
Eigen::MatrixXd Y_
 
String type_
 
std::multiset< unsigned int > descriptor_IDs_
 

Detailed Description

Definition at line 17 of file linearModel.h.

Constructor & Destructor Documentation

BALL::QSAR::LinearModel::LinearModel ( const QSARData q)

constructur,

Parameters
qQSAR-wrapper object, from which the data for this model should be taken
BALL::QSAR::LinearModel::~LinearModel ( )

Member Function Documentation

void BALL::QSAR::LinearModel::calculateOffsets ( )
protectedvirtual
virtual void BALL::QSAR::LinearModel::operator= ( const LinearModel m)
virtual
virtual Eigen::VectorXd BALL::QSAR::LinearModel::predict ( const vector< double > &  substance,
bool  transform = 1 
)
virtual

Predicts the activities of a given substance

Parameters
substancethe substance which activity is to be predicted in form of a vecor containing the values for all descriptors (if neccessary, relevant descriptors will be selected automatically)
transformdetermines whether the values for each descriptor of the given substance should be transformed before prediction of activity.
If (transform==1): each descriptor value is transformed according to the centering of the respective column of QSARData.descriptor_matrix used to train this model.
If the substance to be predicted is part of the same input data (e.g. same SD-file) as the training data (as is the case during cross validation), transform should therefore be set to 0.
Returns
a RowVector containing one value for each predicted activity

Implements BALL::QSAR::Model.