Click or drag to resize
Accord.NET (logo)

Branching Class

Branching filter.
Inheritance Hierarchy
SystemObject
  Accord.Statistics.FiltersBaseFilterBranchingOptions, Branching
    Accord.Statistics.FiltersBranching

Namespace:  Accord.Statistics.Filters
Assembly:  Accord.Statistics (in Accord.Statistics.dll) Version: 3.8.0
Syntax
[SerializableAttribute]
public class Branching : BaseFilter<BranchingOptions, Branching>
Request Example View Source

The Branching type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyActive
Gets or sets whether this filter is active. An inactive filter will repass the input table as output unchanged.
(Inherited from BaseFilterTOptions, TFilter.)
Public propertyColumns
Gets the collection of filter options.
(Inherited from BaseFilterTOptions, TFilter.)
Public propertyItemInt32
Gets options associated with a given variable (data column).
(Inherited from BaseFilterTOptions, TFilter.)
Public propertyItemString
Gets options associated with a given variable (data column).
(Inherited from BaseFilterTOptions, TFilter.)
Public propertyNumberOfInputs
Gets the number of inputs accepted by the model.
(Inherited from BaseFilterTOptions, TFilter.)
Public propertyToken
Gets or sets a cancellation token that can be used to stop the learning algorithm while it is running.
(Inherited from BaseFilterTOptions, TFilter.)
Top
Methods
  NameDescription
Public methodAdd
Add a new column options definition to the collection.
(Inherited from BaseFilterTOptions, TFilter.)
Public methodApply(DataTable)
Applies the Filter to a DataTable.
(Inherited from BaseFilterTOptions, TFilter.)
Public methodApply(DataTable, String)
Applies the Filter to a DataTable.
(Inherited from BaseFilterTOptions, TFilter.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from BaseFilterTOptions, TFilter.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAddingOptions
Called when a new column options definition is being added. Can be used to validate or modify these options beforehand.
(Inherited from BaseFilterTOptions, TFilter.)
Protected methodProcessFilter
Processes the current filter.
(Overrides BaseFilterTOptions, TFilterProcessFilter(DataTable).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodHasMethod
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.)
Public Extension MethodIsEqual
Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices.
(Defined by Matrix.)
Public Extension MethodTo(Type)Overloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Top
Remarks
The branching filter allows for different filter sequences to be applied to different subsets of a data table. For instance, consider a data table whose first column, "IsStudent", is an indicator variable: a value of 1 indicates the row contains information about a student, and a value of 0 indicates the row contains information about someone who is not currently a student. Using the branching filter, it becomes possible to apply a different set of filters for the rows that represent students and different filters for rows that represent non-students.
Examples

Suppose we have the following data table. In this table, each row represents a person, an indicator variable tell us whether this person is a smoker, and the last column indicates the age of each person. Let's say we would like to convert the age of smokers to a scale from -1 to 0, and the age of non-smokers to a scale from 0 to 1.

object[,] data = 
{
    { "Id",  "IsSmoker", "Age" },
    {   0,       1,        10  },
    {   1,       1,        15  },
    {   2,       0,        40  },
    {   3,       1,        20  },
    {   4,       0,        70  },
    {   5,       0,        55  },
};

// Create a DataTable from data
DataTable input = data.ToTable();

// We will create two filters, one to operate on the smoking
// branch of the data, and other in the non-smoking subjects.
// 
var smoker = new LinearScaling();
var common = new LinearScaling();

// for the smokers, we will convert the age to [-1; 0]
smoker.Columns.Add(new LinearScaling.Options("Age")
{
    SourceRange = new DoubleRange(10, 20),
    OutputRange = new DoubleRange(-1, 0)
});

// for non-smokers, we will convert the age to [0; +1]
common.Columns.Add(new LinearScaling.Options("Age")
{
    SourceRange = new DoubleRange(40, 70),
    OutputRange = new DoubleRange(0, 1)
});

// We now configure and create the branch filter
var settings = new Branching.Options("IsSmoker");
settings.Filters.Add(1, smoker);
settings.Filters.Add(0, common);

Branching branching = new Branching(settings);


// Finally, we can process the input data:
DataTable actual = branching.Apply(input);

// As result, the generated table will
// then contain the following entries:

//  { "Id",  "IsSmoker", "Age" },
//  {   0,       1,      -1.0  },
//  {   1,       1,      -0.5  },
//  {   2,       0,       0.0  },
//  {   3,       1,       0.0  },
//  {   4,       0,       1.0  },
//  {   5,       0,       0.5  },
See Also