ModelInputGroup.Populate Method

Definition

Namespace: Extreme.DataAnalysis.Models
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

Populate(IEnumerable<ICategoricalVector>)	Populates the model input group from a sequence of categorical vectors.
Populate(ICategoricalVector, String)	Populates the model input group from the specified vector.
Populate(IDataFrame, String)	Populates the model input group using the specified data frame and column key.
Populate(IDataFrame, String[])	Populates the model input group using the specified data frame and column keys.
Populate(IEnumerable<Vector<Double>>, Boolean)	Populates the model input group from a sequence of vectors.
Populate(Vector<Double>, String)	Populates the model input group from the specified vector.
Populate(IDataFrame, Boolean, String[])	Populates the model input group using the specified data frame and column keys.
Populate(Matrix<Double>, Boolean, String)	Populates the model input group using the specified matrix.
Populate(IDataFrame, Boolean, String, Boolean, Boolean)	Populates the model input group using the specified data frame, optionally clearing the group's schema first.

Populate(IEnumerable<ICategoricalVector>)

Populates the model input group from a sequence of categorical vectors.

public void Populate(
	IEnumerable<ICategoricalVector> columns
)

Visual Basic

Public Sub Populate ( 
	columns As IEnumerable(Of ICategoricalVector)
)

C++/CLI

public:
void Populate(
	IEnumerable<ICategoricalVector^>^ columns
)

member Populate : 
        columns : IEnumerable<ICategoricalVector> -> unit

Parameters

columns IEnumerable<ICategoricalVector>: A sequence of categorical vectors.

Exceptions

ArgumentNullException

columns is null.

Populate(ICategoricalVector, String)

Populates the model input group from the specified vector.

public void Populate(
	ICategoricalVector values,
	string name = null
)

Visual Basic

Public Sub Populate ( 
	values As ICategoricalVector,
	Optional name As String = Nothing
)

C++/CLI

public:
void Populate(
	ICategoricalVector^ values, 
	String^ name = nullptr
)

member Populate : 
        values : ICategoricalVector * 
        ?name : string 
(* Defaults:
        let _name = defaultArg name null
*)
-> unit

Parameters

values ICategoricalVector: A real vector.
name String (Optional): (Optional.) The name of the variable.

Populate(IDataFrame, String)

Populates the model input group using the specified data frame and column key.

public void Populate(
	IDataFrame frame,
	string key
)

Visual Basic

Public Sub Populate ( 
	frame As IDataFrame,
	key As String
)

C++/CLI

public:
void Populate(
	IDataFrame^ frame, 
	String^ key
)

member Populate : 
        frame : IDataFrame * 
        key : string -> unit

Parameters

frame IDataFrame: A data frame or matrix.
key String: The key of the column that contains the data.

Exceptions

ArgumentNullException

frame is null.

Populate(IDataFrame, String[])

Populates the model input group using the specified data frame and column keys.

public void Populate(
	IDataFrame frame,
	params string[] keys
)

Visual Basic

Public Sub Populate ( 
	frame As IDataFrame,
	ParamArray keys As String()
)

C++/CLI

public:
void Populate(
	IDataFrame^ frame, 
	... array<String^>^ keys
)

member Populate : 
        frame : IDataFrame * 
        keys : string[] -> unit

Parameters

frame IDataFrame: A data frame or matrix.
keys String[]: The keys of the column that contains the data.

Exceptions

ArgumentNullException

frame is null.

-or-

keys is null.

Populate(IEnumerable<Vector<Double>>, Boolean)

Populates the model input group from a sequence of vectors.

public void Populate(
	IEnumerable<Vector<double>> columns,
	bool noIntercept = true
)

Visual Basic

Public Sub Populate ( 
	columns As IEnumerable(Of Vector(Of Double)),
	Optional noIntercept As Boolean = true
)

C++/CLI

public:
void Populate(
	IEnumerable<Vector<double>^>^ columns, 
	bool noIntercept = true
)

member Populate : 
        columns : IEnumerable<Vector<float>> * 
        ?noIntercept : bool 
(* Defaults:
        let _noIntercept = defaultArg noIntercept true
*)
-> unit

Parameters

columns IEnumerable<Vector<Double>>: A sequence of categorical vectors.
noIntercept Boolean (Optional): Specifies whether an intercept (constant) term should be included or not.

Exceptions

ArgumentNullException

columns is null.

Populate(Vector<Double>, String)

Populates the model input group from the specified vector.

public void Populate(
	Vector<double> values,
	string name = null
)

Visual Basic

Public Sub Populate ( 
	values As Vector(Of Double),
	Optional name As String = Nothing
)

C++/CLI

public:
void Populate(
	Vector<double>^ values, 
	String^ name = nullptr
)

member Populate : 
        values : Vector<float> * 
        ?name : string 
(* Defaults:
        let _name = defaultArg name null
*)
-> unit

Parameters

values Vector<Double>: A real vector.
name String (Optional): (Optional.) The name of the variable.

Populate(IDataFrame, Boolean, String[])

Populates the model input group using the specified data frame and column keys.

public void Populate(
	IDataFrame frame,
	bool noIntercept,
	string[] keys
)

Visual Basic

Public Sub Populate ( 
	frame As IDataFrame,
	noIntercept As Boolean,
	keys As String()
)

C++/CLI

public:
void Populate(
	IDataFrame^ frame, 
	bool noIntercept, 
	array<String^>^ keys
)

member Populate : 
        frame : IDataFrame * 
        noIntercept : bool * 
        keys : string[] -> unit

Parameters

frame IDataFrame: A data frame or matrix.
noIntercept Boolean: Specifies whether an intercept (constant) term should be included or not.
keys String[]: The keys of the column that contains the data.

Exceptions

ArgumentNullException

frame is null.

-or-

keys is null.

Populate(Matrix<Double>, Boolean, String)

Populates the model input group using the specified matrix.

public void Populate(
	Matrix<double> values,
	bool noIntercept = true,
	string prefix = null
)

Visual Basic

Public Sub Populate ( 
	values As Matrix(Of Double),
	Optional noIntercept As Boolean = true,
	Optional prefix As String = Nothing
)

C++/CLI

public:
void Populate(
	Matrix<double>^ values, 
	bool noIntercept = true, 
	String^ prefix = nullptr
)

member Populate : 
        values : Matrix<float> * 
        ?noIntercept : bool * 
        ?prefix : string 
(* Defaults:
        let _noIntercept = defaultArg noIntercept true
        let _prefix = defaultArg prefix null
*)
-> unit

Parameters

values Matrix<Double>: A real matrix.
noIntercept Boolean (Optional): Indicates whether a constant term should be included in the group.
prefix String (Optional): The prefix to use when generating names for the variables.

Exceptions

ArgumentNullException

values is null.

Populate(IDataFrame, Boolean, String, Boolean, Boolean)

Populates the model input group using the specified data frame, optionally clearing the group's schema first.

public void Populate(
	IDataFrame frame,
	bool allowSkip = true,
	string prefix = null,
	bool clearSchema = false,
	bool noIntercept = true
)

Visual Basic

Public Sub Populate ( 
	frame As IDataFrame,
	Optional allowSkip As Boolean = true,
	Optional prefix As String = Nothing,
	Optional clearSchema As Boolean = false,
	Optional noIntercept As Boolean = true
)

C++/CLI

public:
void Populate(
	IDataFrame^ frame, 
	bool allowSkip = true, 
	String^ prefix = nullptr, 
	bool clearSchema = false, 
	bool noIntercept = true
)

member Populate : 
        frame : IDataFrame * 
        ?allowSkip : bool * 
        ?prefix : string * 
        ?clearSchema : bool * 
        ?noIntercept : bool 
(* Defaults:
        let _allowSkip = defaultArg allowSkip true
        let _prefix = defaultArg prefix null
        let _clearSchema = defaultArg clearSchema false
        let _noIntercept = defaultArg noIntercept true
*)
-> unit

Parameters

frame IDataFrame: The data frame from which to populate the model input group.
allowSkip Boolean (Optional): (Optional.) Specifies whether columns with an incompatible data type may be skipped. The default is true.
prefix String (Optional): (Optional.) Prefix to be used when constructing column keys when frame does not have a column index.
clearSchema Boolean (Optional): Specifies whether the group's current schema should be cleared and a new schema inferred from the data frame.
noIntercept Boolean (Optional): Specifies whether an intercept (constant) term should be included or not.

Exceptions

ArgumentNullException	frame is null.
InvalidOperationException

ModelInputGroup.Populate Method

Definition

Overload List

Populate(IEnumerable<ICategoricalVector>)

Parameters

Exceptions

Populate(ICategoricalVector, String)

Parameters

Populate(IDataFrame, String)

Parameters

Exceptions

Populate(IDataFrame, String[])

Parameters

Exceptions

Populate(IEnumerable<Vector<Double>>, Boolean)

Parameters

Exceptions

Populate(Vector<Double>, String)

Parameters

Populate(IDataFrame, Boolean, String[])

Parameters

Exceptions

Populate(Matrix<Double>, Boolean, String)

Parameters

Exceptions

Populate(IDataFrame, Boolean, String, Boolean, Boolean)

Parameters

Exceptions

See Also

Reference