ModelInputGroup.Populate Method

Definition

Namespace: Numerics.NET.DataAnalysis.Models
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

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.
C#
public void Populate(
	IEnumerable<ICategoricalVector> columns
)

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.
C#
public void Populate(
	ICategoricalVector? values,
	string? name = null
)

Parameters

values  ICategoricalVector
A vector of categorical data.
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.
C#
public void Populate(
	IDataFrame frame,
	string? key
)

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.
C#
public void Populate(
	IDataFrame frame,
	params string[]? keys
)

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.
C#
public void Populate(
	IEnumerable<Vector<double>> columns,
	bool noIntercept = true
)

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.
C#
public void Populate(
	Vector<double>? values,
	string? name = null
)

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.
C#
public void Populate(
	IDataFrame frame,
	bool noIntercept,
	string[]? keys
)

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.
C#
public void Populate(
	Matrix<double> values,
	bool noIntercept = true,
	string? prefix = null
)

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.
C#
public void Populate(
	IDataFrame frame,
	bool allowSkip = true,
	string? prefix = null,
	bool clearSchema = false,
	bool noIntercept = true
)

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

See Also