ModelTerm Class

Extreme Optimization Numerical Libraries for .NET Professional

Represents a term in a model specification.

Inheritance Hierarchy

SystemObject
Extreme.DataAnalysis.ModelsModelTerm
Extreme.DataAnalysis.ModelsModelTermCollection

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

Syntax

C++

Copy

[SerializableAttribute]
public abstract class ModelTerm : IComparable<ModelTerm>, 
	IEquatable<ModelTerm>

<SerializableAttribute>
Public MustInherit Class ModelTerm
	Implements IComparable(Of ModelTerm), IEquatable(Of ModelTerm)

[SerializableAttribute]
public ref class ModelTerm abstract : IComparable<ModelTerm^>, 
	IEquatable<ModelTerm^>

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type ModelTerm =  
    class
        interface IComparable<ModelTerm>
        interface IEquatable<ModelTerm>
    end

The ModelTerm type exposes the following members.

Constructors

	Name	Description
	ModelTerm	Constructs a new model term.

Top

Properties

	Name	Description
	Children	Returns a list of child terms referenced by this term.
	ColumnCount	Returns the number of numerical columns the term maps to.
	Columns	Enumerates the numerical columns the term maps to.
	IsBound	Gets whether all the variables in the term are bound to a column in a data frame.
	IsReducible	Gets whether the term can be reduced to a derived term or set of terms.
	Kind	Returns the kind of term.

Top

Methods

	Name	Description
	Bind	Returns a new model term whose variables are bound to the specified data frame.
	Categorical	Returns a categorical term with the specified key, category index, and encoding scheme.
	CompareTo	Compares this term to another one.
	Difference	Creates a model term that represents the difference between two terms.
	Equals(ModelTerm)	Returns whether one model term equals another.
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Expand	Expands the model term into a term that contains only primitive terms.
	ExpandToCategorical	Expands the term into a collection of primitive numerical terms.
	ExpandToNumerical	Expands the term into a collection of primitive numerical terms.
	ExpressionU	Returns a model term based on an expression that uses the specified variables.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Interaction(ModelTerm)	Creates an interaction between multiple terms.
	Interaction(ModelTerm, ModelTerm)	Creates an interaction between two terms.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Model	Creates a model term that represents the difference between two terms.
	Numerical(String)	Adds a numerical term with the specified key.
	Numerical(IIndex, Boolean)	Returns a collection of model terms for the columns with the specified keys in an index.
	Numerical(Int32, String, Boolean, Int32)	Returns a collection of numerical terms with keys generated from the specified prefix.
	Polynomial(ModelTerm, Int32)	Creates a model term that represents a polynomial in the specified term.
	Polynomial(String, Int32)	Constructs a term corresponding to a polynomial.
	Product	Creates a model term that represents the complete interaction between two terms.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Union	Creates a union of multiple terms.
	Variable(String)	Returns a model term with the specified key.
	Variable(IDataFrame, String)	Returns a model term for the column with the specified key in the data source.
	Variables(IListString, Boolean)	Returns a collection of model terms for the columns with the specified keys.
	Variables(IDataFrame, String, Boolean)	Returns a collection of model terms for the columns with the specified keys in a data frame.

Top

Fields

	Name	Description
	Constant	Represents a constant term or intercept.
	DefaultDependentPrefix	Gets or sets the prefix to use for generating names of dependent variable(s) when no name was provided.
	DefaultIndependentPrefix	Gets or sets the prefix to use for generating names of independent variable(s) when no name was provided.
	DefaultInterceptName	Gets or sets the default name for the parameter corresponding to the intercept (constant term).
	DefaultWeightName	Gets or sets the name to use for the weight variable when no name was provided.
	NoConstant	Represents a term that indicates the constant term or intercept should be excluded.

Top

Remarks

Use the ModelTerm's methods to construct model terms as part of a model specification.

Reference

Extreme.DataAnalysis.Models Namespace

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2023, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.