Package regress
Class RegInducer
java.lang.Object
regress.RegInducer
- All Implemented Interfaces:
util.Executable
Class for inducing multivariate polynomial regression models.
- Since:
- 2007.05.14
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
abort()
Abort a regression model induction.void
exec()
Execute the model induction.Get the induced regression model.int
Get the number of processed table rows.void
induce()
Induce a regression model.static void
Main function for command line execution.void
setDegree
(int deg) Set the degree of the regression polynomial.void
setDomains
(String fn_dom) Set the domain description file.void
setDomains
(table.Table tab) Set the domain descriptions.void
setDomains
(util.Scanner scan) Set the scanner to read the domain descriptions from.void
Set the table input file and corresponding parameters.void
Set the table input file and corresponding parameters.void
Set the table input file and corresponding parameters.void
Set the table input file and corresponding parameters.void
setInput
(table.Table tab) Set the input data table.void
setInput
(util.TableReader reader) Set the table reader and read mode.void
setInput
(util.TableReader reader, int mode) Set the table reader and read mode.void
setLim
(double lim) Set the limit for the Tikhonov regularization.void
setMax
(double max) Set the maximum for a logit transformation.void
setMin
(double min) Set the minimum for a logit transformation.void
setMinMax
(double min, double max) Set the range for a logit transformation.void
Set the output file writer.void
Set the output file.void
setReg
(double reg) Set the initial Tikhonov regularization.void
setRegLim
(double reg, double lim) Set initial value and limit for the Tikhonov regularization.void
setTarget
(int trgid) Set the id of the target column.void
Set the name of the target column.
-
Field Details
-
DESCRIPTION
the program description- See Also:
-
VERSION
the version of this program- See Also:
-
COPYRIGHT
the copyright information for this program- See Also:
-
-
Constructor Details
-
RegInducer
public RegInducer()Create a regression model inducer.- Since:
- 2007.05.16 (Christian Borgelt)
-
-
Method Details
-
setDomains
Set the domain description file.- Parameters:
fn_dom
- the name of the domain description file- Since:
- 2007.05.17 (Christian Borgelt)
-
setDomains
public void setDomains(util.Scanner scan) Set the scanner to read the domain descriptions from.- Parameters:
scan
- the scanner to read the domain descriptions from- Since:
- 2007.05.18 (Christian Borgelt)
-
setDomains
public void setDomains(table.Table tab) Set the domain descriptions.- Parameters:
tab
- the domain descriptions- Since:
- 2007.05.17 (Christian Borgelt)
-
setTarget
Set the name of the target column.- Parameters:
target
- the name of the target column- Since:
- 2007.05.17 (Christian Borgelt)
-
setTarget
public void setTarget(int trgid) Set the id of the target column.- Parameters:
trgid
- the id of the target column- Since:
- 2007.05.17 (Christian Borgelt)
-
setInput
Set the table input file and corresponding parameters.- Parameters:
fn_tab
- the name of the data table file- Since:
- 2007.05.18 (Christian Borgelt)
-
setInput
Set the table input file and corresponding parameters.- Parameters:
fn_tab
- the name of the data table filemode
- the read mode- Since:
- 2007.05.18 (Christian Borgelt)
-
setInput
Set the table input file and corresponding parameters.- Parameters:
fn_tab
- the name of the data table filerecseps
- the record separatorsfldseps
- the field separatorsblanks
- the blank characterscomment
- the comment characters- Since:
- 2007.05.17 (Christian Borgelt)
-
setInput
public void setInput(String fn_tab, String recseps, String fldseps, String blanks, String comment, int mode) Set the table input file and corresponding parameters.- Parameters:
fn_tab
- the name of the data table filerecseps
- the record separatorsfldseps
- the field separatorsblanks
- the blank characterscomment
- the comment charactersmode
- the read mode- Since:
- 2007.05.17 (Christian Borgelt)
-
setInput
public void setInput(util.TableReader reader) Set the table reader and read mode.- Parameters:
reader
- the table reader- Since:
- 2007.05.17 (Christian Borgelt)
-
setInput
public void setInput(util.TableReader reader, int mode) Set the table reader and read mode.- Parameters:
reader
- the table readermode
- the read mode- Since:
- 2007.05.17 (Christian Borgelt)
-
setInput
public void setInput(table.Table tab) Set the input data table.- Parameters:
tab
- the input data table- Since:
- 2007.05.17 (Christian Borgelt)
-
setDegree
public void setDegree(int deg) Set the degree of the regression polynomial.The default degree is 1.
- Parameters:
deg
- the degree of the regression polynomial- Since:
- 2007.05.16 (Christian Borgelt)
-
setMin
public void setMin(double min) Set the minimum for a logit transformation.- Parameters:
min
- the maximum for a logit transformation- Since:
- 2015.08.12 (Christian Borgelt)
-
setMax
public void setMax(double max) Set the maximum for a logit transformation.- Parameters:
max
- the maximum for a logit transformation- Since:
- 2007.05.16 (Christian Borgelt)
-
setMinMax
public void setMinMax(double min, double max) Set the range for a logit transformation.- Parameters:
min
- the minimum for a logit transformationmax
- the maximum for a logit transformation- Since:
- 2015.08.12 (Christian Borgelt)
-
setReg
public void setReg(double reg) Set the initial Tikhonov regularization.- Parameters:
reg
- the initial regularization value- Since:
- 2015.08.12 (Christian Borgelt)
-
setLim
public void setLim(double lim) Set the limit for the Tikhonov regularization.- Parameters:
lim
- the limit for the regularization value- Since:
- 2015.08.12 (Christian Borgelt)
-
setRegLim
public void setRegLim(double reg, double lim) Set initial value and limit for the Tikhonov regularization.- Parameters:
reg
- the initial regularization valuelim
- the limit for the regularization value- Since:
- 2015.08.12 (Christian Borgelt)
-
setOutput
Set the output file.- Parameters:
fn_reg
- the name of the regression model file- Since:
- 2007.05.17 (Christian Borgelt)
-
setOutput
Set the output file writer.- Parameters:
writer
- the output file writer- Since:
- 2007.05.17 (Christian Borgelt)
-
getRegression
Get the induced regression model.- Returns:
- the induced regression model
- Since:
- 2007.05.16 (Christian Borgelt)
-
induce
Induce a regression model.- Throws:
IOException
- if an i/o error occursRegException
- if there are too many regression terms- Since:
- 2007.05.16 (Christian Borgelt)
-
exec
Execute the model induction.- Specified by:
exec
in interfaceutil.Executable
- Throws:
Exception
- if a execution error occurs- Since:
- 2007.05.16 (Christian Borgelt)
-
abort
public void abort()Abort a regression model induction.- Specified by:
abort
in interfaceutil.Executable
- Since:
- 2007.05.16 (Christian Borgelt)
-
getRowCount
public int getRowCount()Get the number of processed table rows.- Returns:
- the number of processed table rows
- Since:
- 2007.05.18 (Christian Borgelt)
-
main
Main function for command line execution.- Parameters:
args
- the command line arguments- Since:
- 2007.05.16 (Christian Borgelt)
-