Filter Class

Represents a filter that can be used to select observations in a Vector<T> or IDataFrame.

Definition

Namespace: Numerics.NET.Statistics
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.2
C#
[SerializableAttribute]
public class Filter : IEnumerable<int>, IEnumerable
Inheritance
Object  →  Filter
Derived
Implements
IEnumerable<Int32>, IEnumerable

Remarks

Use the Filter object to select a subset of the observations in a Vector<T> or IDataFrame.

Constructors

Filter(Int32, Int32[]) Constructs a new Filter from an array of indexes.
Filter(Int32, Int32, Int32) Constructs a new Filter from a range of indexes.
Filter(Int32, Int32, Int32[], Boolean) Constructs a new Filter object.

Properties

EndIndex Gets the index of the observation past the last visible observation.
FilteredLength Gets the length of the filtered data.
IsContiguous Gets whether the filter selects a contiguous range.
Item Gets the unfiltered index of the observation at the specified index.
Length Gets the length of the unfiltered data.
StartIndex Gets the index of the first visible observation.

Methods

ApplySort Returns a filter that applies the specified sort filter to the current filter.
Complement Returns a Filter that is the complement of the specified filter.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetEnumerator Returns an enumerator that iterates over the indexes in the filter.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetReverse Returns a filter that lists the observations of the current filter in reverse order.
GetTypeGets the Type of the current instance.
(Inherited from Object)
Intersection Returns a filter representing the intersection of two filters.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Reverse Returns a filter that reverses the observations.
ToStringReturns a string that represents the current object.
(Inherited from Object)
Union Returns a filter that represents the union of two filters.

Operators

BitwiseAnd(Filter, Filter) Returns a filter representing the intersection of two filters.
BitwiseOr(Filter, Filter) Returns a filter that represents the union of two filters.
OnesComplement(Filter) Returns a Filter that is the complement of the specified filter.

Extension Methods

Group<Int32> Returns a grouping by the unique elements in a sequence.
(Defined by Grouping)
Group<Int32> Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality.
(Defined by Grouping)
StandardDeviation<Int32> Returns the standard deviation of the elements of a sequence.
(Defined by Stats)
Sum<Int32> Computes the sum of the sequence of values.
(Defined by ArrayMath)
Sum<Int32, U> 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)
Sum<Int32, T2, U> Computes the sum of the sequence of values that are obtained by invoking a transform function on each pair of elements of the input sequences.
(Defined by ArrayMath)

See Also