Methods dedicated to linear regression

Functions
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::AddRegressionModel (std::string modelName, PMMLMiningFunction functionName, std::string targetFieldName)
	Specific to RegressionModel. More...
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::AddRegressionTable ()
	No property "intercept" will be set. More...
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::AddRegressionTable (double intercept)
	Specific to RegressionModel. More...
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::AddNumericPredictor (std::string neuronName, int exponent, double coefficient)
	Specific to RegressionModel. More...
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::AddPredictorTerm (double coefficient, std::vector< std::string > fieldRef)
	Specific to RegressionModel More...
PMMLLIB_EXPORT bool	PMMLlib::PMMLlib::HasIntercept ()
	Specific to RegressionModel More...
PMMLLIB_EXPORT double	PMMLlib::PMMLlib::GetRegressionTableIntercept ()
	Specific to RegressionModel More...
PMMLLIB_EXPORT int	PMMLlib::PMMLlib::GetNumericPredictorNb ()
	Specific to RegressionModel More...
PMMLLIB_EXPORT int	PMMLlib::PMMLlib::GetPredictorTermNb ()
	Specific to RegressionModel More...
PMMLLIB_EXPORT std::string	PMMLlib::PMMLlib::GetNumericPredictorName (int num_pred_index)
	Specific to RegressionModel More...
PMMLLIB_EXPORT std::string	PMMLlib::PMMLlib::GetPredictorTermName (int num_pred_index)
	Specific to RegressionModel More...
PMMLLIB_EXPORT double	PMMLlib::PMMLlib::GetNumericPredictorCoefficient (int num_pred_index)
	(The coefficient is the value of property "coefficient") More...
PMMLLIB_EXPORT double	PMMLlib::PMMLlib::GetPredictorTermCoefficient (int pred_term_index)
	(The coefficient is the value of property "coefficient") More...
PMMLLIB_EXPORT int	PMMLlib::PMMLlib::GetPredictorTermFieldRefNb (int pred_term_index)
	Specific to RegressionModel More...
PMMLLIB_EXPORT std::string	PMMLlib::PMMLlib::GetPredictorTermFieldRefName (int pred_term_index, int field_index)
	(The name is the value of property "field") More...
PMMLLIB_EXPORT std::string	PMMLlib::PMMLlib::ReadRegressionStructure ()
	Specific to RegressionModel. More...
xmlNodePtr	PMMLlib::PMMLlib::GetRegressionPtr (int reg_index)
xmlNodePtr	PMMLlib::PMMLlib::GetRegressionPtr (std::string reg_name)
void	PMMLlib::PMMLlib::CheckRegression ()
	Called in all methods specific to the RegressionModel model. More...

Detailed Description

Methods dedicated to linear regression

Function Documentation

AddNumericPredictor()

void PMMLlib::PMMLlib::AddNumericPredictor	(	std::string	neuronName,
		int	exponent,
		double	coefficient
	)

Specific to RegressionModel.

Add a numeric predictor to the Regression model.

Parameters

neuronName	Value of property "name"
exponent	Value of property "exponent"
coefficient	Value of property "coefficient"

Definition at line 2309 of file PMMLlib.cxx.

{
    CheckRegression(); 
    stringstream ss;
    xmlNodePtr numPrecNode = xmlNewChild(_currentNode, 0, (const xmlChar*)"NumericPredictor", 0);
    xmlNewProp(numPrecNode, (const xmlChar*)"name", (const xmlChar*)(neuronName.c_str()) );
    ss.str("");  ss << exponent;
    xmlNewProp(numPrecNode, (const xmlChar*)"exponent", (const xmlChar*)(ss.str().c_str()) );
    ss.str("");  ss << scientific << coefficient;
    xmlNewProp(numPrecNode, (const xmlChar*)"coefficient", (const xmlChar*)(ss.str().c_str()) );
}

AddPredictorTerm()

void PMMLlib::PMMLlib::AddPredictorTerm	(	double	coefficient,
		std::vector< std::string >	fieldRef
	)

Specific to RegressionModel

Add a predictor term to the Regression model.

Parameters

coefficient	Value of property "coefficient"
fieldRef	List of values for property "field", one per FieldRef to add to the PredictorTerm

Definition at line 2329 of file PMMLlib.cxx.

{
    CheckRegression();
    stringstream ss;
    xmlNodePtr predTermNode = xmlNewChild(_currentNode, 0, (const xmlChar*)"PredictorTerm", 0);
    ss.str("");  ss << scientific << coefficient;
    xmlNewProp(predTermNode, (const xmlChar*)"coefficient", (const xmlChar*)(ss.str().c_str()) );
    vector<string>::iterator it;
    for(it=fieldRef.begin() ; it!=fieldRef.end() ; it++)
    {
        xmlNodePtr fieldRefNode = xmlNewChild(predTermNode, 0, (const xmlChar*)"FieldRef", 0);
        ss.str(""); ss << (*it);
        xmlNewProp(fieldRefNode, (const xmlChar*)"field", (const xmlChar*)(ss.str().c_str()) );
    }
}

AddRegressionModel()

void PMMLlib::PMMLlib::AddRegressionModel	(	std::string	modelName,
		PMMLMiningFunction	functionName,
		std::string	targetFieldName
	)

Specific to RegressionModel.

Add a RegressionModel to the root node

Parameters

modelName	Name of the model (Value of property "modelName")
functionName	Value of property "functionName"
targetFieldName	Value of Property "targetFieldName"

Definition at line 2248 of file PMMLlib.cxx.

{
    _currentModelType = kLR;
    _currentModelName = modelName;
    // Check regression after setting model type!
    CheckRegression();
    
    string function;
    switch(functionName)
    {
        case kREGRESSION:
            function = "regression"; 
            break;
    }
    xmlNodePtr netNode = xmlNewChild(_rootNode, 0, (const xmlChar*)"RegressionModel", 0);     
    xmlNewProp(netNode, (const xmlChar*)"functionName", (const xmlChar*)(function.c_str()) );
    xmlNewProp(netNode, (const xmlChar*)"modelName", (const xmlChar*)(_currentModelName.c_str()) );
    xmlNewProp(netNode, (const xmlChar*)"targetFieldName", (const xmlChar*)(targetFieldName.c_str()) );
    _currentModelNode = netNode ;
}

References PMMLlib::kLR, and PMMLlib::kREGRESSION.

AddRegressionTable() [1/2]

void PMMLlib::PMMLlib::AddRegressionTable

(

)

No property "intercept" will be set.

Add a RegressionTable to the Regression model.

Specific to RegressionModel

Definition at line 2276 of file PMMLlib.cxx.

{
    CheckRegression();  
    xmlNodePtr tableNode = xmlNewChild(_currentModelNode, 0, (const xmlChar*)"RegressionModel", 0);
    _currentNode = tableNode;
}

AddRegressionTable() [2/2]

void PMMLlib::PMMLlib::AddRegressionTable

(

double

intercept

)

Specific to RegressionModel.

Add a RegressionTable to the Regression model with a given value of property "intercept".

Parameters

intercept

Value of property "intercept"

Definition at line 2288 of file PMMLlib.cxx.

{
    CheckRegression();
 
    stringstream ss;
    xmlNodePtr tableNode = xmlNewChild(_currentModelNode, 0, (const xmlChar*)"RegressionTable", 0);
    if(intercept!=0.0)
    {
        ss << scientific << intercept;
        xmlNewProp(tableNode, (const xmlChar*)"intercept", (const xmlChar*)(ss.str().c_str()) );
    }
    _currentNode = tableNode;
}

CheckRegression()

void PMMLlib::PMMLlib::CheckRegression ( )

private

Called in all methods specific to the RegressionModel model.

Check if the current model type is kLR.

Throw an exception if the model type is not kLR.

Definition at line 2225 of file PMMLlib.cxx.

{
    if ( _currentModelType != kLR )
        throw string("Use this method with Regression models."); 
}

References PMMLlib::kLR.

GetNumericPredictorCoefficient()

double PMMLlib::PMMLlib::GetNumericPredictorCoefficient

(

int

num_pred_index

)

(The coefficient is the value of property "coefficient")

Get the coefficient of the numeric predictor given by its index.

Specific to RegressionModel

Parameters

num_pred_index

Index of the numeric predictor

Returns

Coefficient of the numeric predictor

Definition at line 2503 of file PMMLlib.cxx.

{
    CheckRegression();
    
    double coef = 0.;  
    xmlNodePtr numPredNodes = GetChildByName(_currentModelNode,"RegressionTable");
    if ( numPredNodes == NULL )
        return coef;    
    numPredNodes = GetChildByName(numPredNodes,"NumericPredictor");
    if ( numPredNodes == NULL )
        return coef;
    // Positionnement sur la bonne sortie
    for(int i=0;i<num_pred_index;i++)
    {
        numPredNodes = numPredNodes->next;
        if ( numPredNodes == NULL || 
             string((const char*)(numPredNodes->name)) != "NumericPredictor" )
            return coef;        
    }  
    string strValue = _getProp(numPredNodes, string("coefficient")); 
    coef = atof(strValue.c_str());
    return coef;  
}

References yacsorb.CORBAEngineTest::i.

GetNumericPredictorName()

std::string PMMLlib::PMMLlib::GetNumericPredictorName

(

int

num_pred_index

)

Specific to RegressionModel

Get the name of the numeric predictor given by its index.

Parameters

num_pred_index

Index of the numeric predictor

Returns

Name of the numeric predictor

Definition at line 2438 of file PMMLlib.cxx.

{
    CheckRegression();
    string strName("");   
    xmlNodePtr numPredNodes = GetChildByName(_currentModelNode,"RegressionTable");
    if ( numPredNodes == NULL )
        return strName;
    
    numPredNodes = GetChildByName(numPredNodes,"NumericPredictor");
    if ( numPredNodes == NULL )
        return strName;
    // Positionnement sur la bonne sortie PredictorTerm
    for(int i=0;i<num_pred_index;i++)
    {
        numPredNodes = numPredNodes->next;
        if ( numPredNodes == NULL || 
             string((const char*)(numPredNodes->name)) != "NumericPredictor" )
            return strName;        
    }        
    strName = _getProp(numPredNodes, string("name"));
    return strName;
}

References yacsorb.CORBAEngineTest::i.

GetNumericPredictorNb()

int PMMLlib::PMMLlib::GetNumericPredictorNb

(

)

Specific to RegressionModel

Get the number of numeric predictors.

Returns

Number of numeric predictors

Definition at line 2392 of file PMMLlib.cxx.

{
    CheckRegression();
    
    int nb=0;   
    xmlNodePtr tableNode = GetChildByName(_currentModelNode,"RegressionTable");
    if ( tableNode == NULL )
        return nb;
    xmlNodePtr numPredNodes =  tableNode->children;
    while (numPredNodes != NULL )
    {
        if ( string((const char*)(numPredNodes->name)) == "NumericPredictor" )
            nb++;
        numPredNodes = numPredNodes->next;
    }    
    return nb;
}

GetPredictorTermCoefficient()

double PMMLlib::PMMLlib::GetPredictorTermCoefficient

(

int

pred_term_index

)

(The coefficient is the value of property "coefficient")

Get the coefficient of the predictor term given by its index.

Specific to RegressionModel

Parameters

pred_term_index

Index of the predictor term

Returns

Coefficient of the predictor term

Definition at line 2534 of file PMMLlib.cxx.

{
    CheckRegression();
    
    double coef = 0.;   
    xmlNodePtr predTermNodes = GetChildByName(_currentModelNode,"RegressionTable");
    if ( predTermNodes == NULL )
        return coef;    
    predTermNodes = GetChildByName(predTermNodes,"PredictorTerm");
    if ( predTermNodes == NULL )
        return coef;
    // Positionnement sur la bonne sortie
    for(int i=0;i<pred_term_index;i++)
    {
        predTermNodes = predTermNodes->next;
        if ( predTermNodes == NULL || 
             string((const char*)(predTermNodes->name)) != "PredictorTerm" )
            return coef;        
    }  
    string strValue = _getProp(predTermNodes, string("coefficient")); 
    coef = atof(strValue.c_str());
    return coef;
}

References yacsorb.CORBAEngineTest::i.

GetPredictorTermFieldRefName()

std::string PMMLlib::PMMLlib::GetPredictorTermFieldRefName	(	int	pred_term_index,
		int	field_index
	)

(The name is the value of property "field")

Get the name of the field_index-th FieldRef for the pred_term_index-th predictor term.

Specific to RegressionModel

Parameters

pred_term_index	Index of the predictor term
field_index	Index of the FieldRef

Returns

Name of the FieldRef

Definition at line 2600 of file PMMLlib.cxx.

{
    CheckRegression();
    
    string strName("");    
    xmlNodePtr fieldRefNodes = GetChildByName(_currentModelNode,"RegressionTable");
    if ( fieldRefNodes == NULL )
      return strName;
    fieldRefNodes = GetChildByName(fieldRefNodes,"PredictorTerm");
    if ( fieldRefNodes == NULL )
        return strName;
    // Positionnement sur la bonne sortie PredictorTerm
    for(int i=0;i<pred_term_index;i++)
    {
        fieldRefNodes = fieldRefNodes->next;
        if ( fieldRefNodes == NULL || 
             string((const char*)(fieldRefNodes->name)) != "PredictorTerm" )
            return strName;        
    }  
    fieldRefNodes = fieldRefNodes->children;
    if ( fieldRefNodes == NULL )
        return strName;
    // Positionnement sur la bonne sortie FieldRef
    for(int i=0;i<field_index;i++)
    {
        fieldRefNodes = fieldRefNodes->next;
        if ( fieldRefNodes == NULL )
            return strName;        
    }     
    strName = _getProp(fieldRefNodes, string("field"));
    return strName;
}

References yacsorb.CORBAEngineTest::i.

GetPredictorTermFieldRefNb()

int PMMLlib::PMMLlib::GetPredictorTermFieldRefNb

(

int

index

)

Specific to RegressionModel

Get the number of FieldRef for the predictor term given by its index.

Parameters

indsex

Index of the predictor term

Returns

Number of FieldRef

Definition at line 2564 of file PMMLlib.cxx.

{
    CheckRegression();
    
    int nb=0;
    xmlNodePtr fieldRefNodes = GetChildByName(_currentModelNode,"RegressionTable");
    if ( fieldRefNodes == NULL )
      return nb;
    fieldRefNodes = GetChildByName(fieldRefNodes,"PredictorTerm");
    if ( fieldRefNodes == NULL )
        return nb;
    // Positionnement sur la bonne sortie
    for(int i=0;i<index;i++)
    {
        fieldRefNodes = fieldRefNodes->next;
        if ( fieldRefNodes == NULL || 
             string((const char*)(fieldRefNodes->name)) != "PredictorTerm" )
            return nb;        
    }  
    fieldRefNodes = fieldRefNodes->children;
    while (fieldRefNodes != NULL)
    {
        nb++;
        fieldRefNodes = fieldRefNodes->next;
    }    
    return nb;
}

References yacsorb.CORBAEngineTest::i.

GetPredictorTermName()

std::string PMMLlib::PMMLlib::GetPredictorTermName

(

int

pred_term_index

)

Specific to RegressionModel

Get the name of the predictor term given by its index.

Parameters

pred_term_index

Index of the predictor term

Returns

Name of the predictor term

Definition at line 2467 of file PMMLlib.cxx.

{
    CheckRegression();
    string strName("");   
    xmlNodePtr fieldRefNodes = GetChildByName(_currentModelNode,"RegressionTable");
    if ( fieldRefNodes == NULL )
        return strName;    
    
    fieldRefNodes = GetChildByName(fieldRefNodes,"PredictorTerm");
    if ( fieldRefNodes == NULL )
        return strName;
    // Positionnement sur la bonne sortie
    for(int i=0;i<pred_term_index;i++)
    {
        fieldRefNodes = fieldRefNodes->next;
        if ( fieldRefNodes == NULL || 
            string((const char*)(fieldRefNodes->name)) != "PredictorTerm" )
            return strName;        
    }  
    
    fieldRefNodes = fieldRefNodes->children;
    while (fieldRefNodes != NULL)
    {
        strName += _getProp(fieldRefNodes, string("field"));
        fieldRefNodes = fieldRefNodes->next;
    }        
    return strName;
}

References yacsorb.CORBAEngineTest::i.

GetPredictorTermNb()

int PMMLlib::PMMLlib::GetPredictorTermNb

(

)

Specific to RegressionModel

Get the number of predictor terms.

Returns

Number of predictor terms

Definition at line 2415 of file PMMLlib.cxx.

{
    CheckRegression();
    int nb=0;    
    xmlNodePtr tableNode = GetChildByName(_currentModelNode,"RegressionTable");
    if ( tableNode == NULL )
      return nb;  
    xmlNodePtr numPredNodes =  tableNode->children;
    while ( numPredNodes != NULL )      
    {
        if ( string((const char*)(numPredNodes->name)) == "PredictorTerm" )
            nb++;
        numPredNodes = numPredNodes->next;
    }    
    return nb;
}

GetRegressionPtr() [1/2]

xmlNodePtr PMMLlib::PMMLlib::GetRegressionPtr ( int  reg_index )

private

GetRegressionPtr() [2/2]

xmlNodePtr PMMLlib::PMMLlib::GetRegressionPtr ( std::string  name )

private

Get the pointeur to the regression model node.

Parameters

name	Name of the regression model

Returns

Pointer to the XML node

Definition at line 2236 of file PMMLlib.cxx.

{
    return GetPtr(name, GetTypeString() );  
}   

GetRegressionTableIntercept()

double PMMLlib::PMMLlib::GetRegressionTableIntercept

(

)

Specific to RegressionModel

Get the value of property "intercept" in the RegressionTable.

Returns

Value of property "intercept"

Definition at line 2376 of file PMMLlib.cxx.

{
    CheckRegression();
    double reg = 0.;
    xmlNodePtr tableNode = GetChildByName(_currentModelNode,"RegressionTable");
    if ( tableNode == NULL )
        return reg; 
    string strValue = _getProp(tableNode, string("intercept") );
    return atof(strValue.c_str());
}

HasIntercept()

bool PMMLlib::PMMLlib::HasIntercept

(

)

Specific to RegressionModel

Check if the RegressionTable has a property called "intercept".

Returns

true if it has, false otherwise

Definition at line 2351 of file PMMLlib.cxx.

{
    CheckRegression();
    bool b = false;   
    xmlNodePtr tableNode = GetChildByName(_currentModelNode,"RegressionTable");
    if ( tableNode == NULL )
      return b;         
    xmlChar *xp = _stringToXmlChar("intercept");
    xmlChar * attr ;
    attr = xmlGetProp(tableNode, xp);
    if ( attr ) 
    {
        xmlFree(attr);
        xmlFree(xp);  
        return true;
    }  
    xmlFree(xp);  
    return false;
}

References gui.CONNECTOR::b.

ReadRegressionStructure()

std::string PMMLlib::PMMLlib::ReadRegressionStructure

(

)

Specific to RegressionModel.

Read the structure of the regression model

Returns

Structure read

Definition at line 2873 of file PMMLlib.cxx.

{   
    CheckRegression(); 
 
    string structure("");    
    string structureActive("");
    string structurePredicted("@");
    int nPred = 0;
    xmlNodePtr mNode = GetChildByName(_currentModelNode,"MiningSchema");
    if ( mNode != NULL )
    {
        xmlNodePtr dNode = GetChildByName(mNode,"MiningField");     
        while (dNode != NULL)
        {
            string name = _getProp(dNode, string("name"));
            string usage = _getProp(dNode, string("usageType"));
            if ( usage == "active" )
            {
                structureActive += name;
                structureActive += ":"; 
            }    
            else if ( usage == "predicted" )
            {
                structurePredicted += name;
                structurePredicted += ":"; 
                nPred++;
            }                 
            dNode = dNode->next;             
        }
        // Delete the last ":"
        if ( structureActive.length() > 0 )
            structureActive.erase(structureActive.size()-1);        
        structurePredicted.erase(structurePredicted.size()-1);
    }
    std::ostringstream oss;
    oss << nPred;   
    structure = structureActive + ","  + oss.str() + "," + structurePredicted;
    return structure;
}