ModelTermCollection Class

Extreme Optimization Numerical Libraries for .NET Professional

Represents a collection of terms 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

public sealed class ModelTermCollection : ModelTerm, 
	IList<ModelTerm>, ICollection<ModelTerm>, IEnumerable<ModelTerm>, 
	IEnumerable

Public NotInheritable Class ModelTermCollection
	Inherits ModelTerm
	Implements IList(Of ModelTerm), ICollection(Of ModelTerm), 
	IEnumerable(Of ModelTerm), IEnumerable

public ref class ModelTermCollection sealed : public ModelTerm, 
	IList<ModelTerm^>, ICollection<ModelTerm^>, IEnumerable<ModelTerm^>, 
	IEnumerable

[<SealedAttribute>]
type ModelTermCollection =  
    class
        inherit ModelTerm
        interface IList<ModelTerm>
        interface ICollection<ModelTerm>
        interface IEnumerable<ModelTerm>
        interface IEnumerable
    end

The ModelTermCollection type exposes the following members.

Constructors

	Name	Description
	ModelTermCollection(Int32)	Constructs a new model term collection with the specified capacity.
	ModelTermCollection(IListModelTerm, Boolean)	Constructs a new collection from the specified terms.
	ModelTermCollection(ModelTerm, Boolean)	Constructs a new collection from a single term.

Top

Properties

	Name	Description
	Children	Returns a list of child terms referenced by this term. (Overrides ModelTermChildren.)
	ColumnCount	Returns the number of numerical columns the term maps to. (Inherited from ModelTerm.)
	Columns	Enumerates the numerical columns the term maps to. (Inherited from ModelTerm.)
	Count	Gets the number of terms in the collection.
	IsBound	Gets whether all the variables in the term are bound to a column in a data frame. (Overrides ModelTermIsBound.)
	IsReducible	Gets whether the term can be reduced to a derived term or set of terms. (Inherited from ModelTerm.)
	Item	Gets or sets the element at the specified index.
	Kind	Returns the kind of term. (Overrides ModelTermKind.)

Top

Methods

	Name	Description
	Add	Adds a model term to the collection.
	AddExpressionU	Adds an expression term to the collection.
	AddPolynomial	Adds a new polynomial term to the collection.
	AddRange	Adds a sequence of model terms to the collection.
	AddVariable	Adds a categorical term to the collection.
	Bind	Returns a new model term whose variables are bound to the specified data frame. (Inherited from ModelTerm.)
	CompareTo	Compares this term to another one. (Inherited from ModelTerm.)
	Contains	Returns whether the collection contains the specified term.
	Equals(ModelTerm)	Returns whether one model term equals another. (Inherited from ModelTerm.)
	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. (Overrides ModelTermExpand(Boolean, Boolean).)
	ExpandToCategorical	Expands the term into a collection of primitive numerical terms. (Inherited from ModelTerm.)
	ExpandToNumerical	Expands the term into a collection of primitive numerical terms. (Inherited from ModelTerm.)
	GetEnumerator	Returns an enumerator that iterates over the terms in the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetIndex	Returns the index of column names for the terms in the collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Top

Extension Methods

	Name	Description
	GroupModelTerm	Overloaded. Returns a grouping by the unique elements in a list. (Defined by Grouping.)
	GroupModelTerm	Overloaded. Returns a grouping by the unique elements in a sequence. (Defined by Grouping.)
	GroupModelTerm(IEqualityComparerModelTerm)	Overloaded. Returns a grouping by the unique elements in a list using the specified comparer to determine equality. (Defined by Grouping.)
	GroupModelTerm(IEqualityComparerModelTerm)	Overloaded. Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality. (Defined by Grouping.)
	SumModelTerm	Overloaded. Computes the sum of the sequence of values. (Defined by ArrayMath.)
	SumModelTerm, U(FuncModelTerm, U)	Overloaded. Computes the sum of the sequence of values that are obtained by invoking a transform function on each element of the input sequence. (Defined by ArrayMath.)

Top

Remarks

Use the ModelTermCollection class to represent a term in a model specification that consists of the union of two or more terms. The most common use is as the right-hand side 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.