Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET

  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Blog
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference
  • Extreme Optimization
    • Features
    • Solutions
    • Documentation
    • QuickStart Samples
    • Sample Applications
    • Downloads
    • Technical Support
    • Download trial
    • How to buy
    • Blog
    • Company
    • Resources
  • Documentation
    • Introduction
    • Deployment Guide
    • Configuration
    • Using Parallelism
    • Mathematics Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Data Access Library User's Guide
    • Reference
  • Reference
    • Extreme
    • Extreme.Collections
    • Extreme.Data
    • Extreme.Data.Json
    • Extreme.Data.Matlab
    • Extreme.Data.R
    • Extreme.Data.Stata
    • Extreme.Data.Text
    • Extreme.DataAnalysis
    • Extreme.DataAnalysis.Linq
    • Extreme.Mathematics
    • Extreme.Mathematics.Algorithms
    • Extreme.Mathematics.Calculus
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • Extreme.Mathematics.Curves
    • Extreme.Mathematics.Curves.Nonlinear
    • Extreme.Mathematics.Distributed
    • Extreme.Mathematics.Distributed.Cuda
    • Extreme.Mathematics.EquationSolvers
    • Extreme.Mathematics.FSharp
    • Extreme.Mathematics.Generic
    • Extreme.Mathematics.Generic.LinearAlgebra
    • Extreme.Mathematics.Generic.LinearAlgebra.Implementation
    • Extreme.Mathematics.Generic.LinearAlgebra.Providers
    • Extreme.Mathematics.Generic.SignalProcessing
    • Extreme.Mathematics.Implementation
    • Extreme.Mathematics.LinearAlgebra
    • Extreme.Mathematics.LinearAlgebra.Complex
    • Extreme.Mathematics.LinearAlgebra.Complex.Decompositions
    • Extreme.Mathematics.LinearAlgebra.Implementation
    • Extreme.Mathematics.LinearAlgebra.IO
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners
    • Extreme.Mathematics.LinearAlgebra.Providers
    • Extreme.Mathematics.LinearAlgebra.Sparse
    • Extreme.Mathematics.Optimization
    • Extreme.Mathematics.Optimization.Genetic
    • Extreme.Mathematics.Optimization.LineSearches
    • Extreme.Mathematics.Random
    • Extreme.Mathematics.SignalProcessing
    • Extreme.Numerics.FSharp
    • Extreme.Statistics
    • Extreme.Statistics.Distributions
    • Extreme.Statistics.IO
    • Extreme.Statistics.Linq
    • Extreme.Statistics.Multivariate
    • Extreme.Statistics.Random
    • Extreme.Statistics.Tests
    • Extreme.Statistics.TimeSeriesAnalysis
  • Extreme.Statistics
    • Aggregator Class
    • AnovaModel Class
    • AnovaModelRow Class
    • AnovaRow Class
    • AnovaRowCollection Class
    • AnovaRowType Enumeration
    • AnovaTable Class
    • BoundaryIntervalBehavior Enumeration
    • CategoricalScale Class
    • CategoricalVariable Class
    • CategoricalVariable.CategoricalFilters Structure
    • Cell Structure
    • CellArray Class
    • ClassificationModel Class
    • ClusteringModel Class
    • CollectionSortOrder Class
    • ContingencyTable Class
    • ContingencyTableCell Structure
    • DataArray(T) Class
    • DataArrayElement(T) Class
    • DateTimeInterval Structure
    • DateTimeScale Class
    • DateTimeUnit Enumeration
    • DateTimeVariable Class
    • DateTimeVariable.DateTimeFilters Structure
    • Descriptives(T) Class
    • Filter Class
    • GeneralizedLinearModel Class
    • Histogram Class
    • HistogramBin Structure
    • HistogramBinCollection Class
    • HypothesisTests Class
    • InsufficientDataException Class
    • ITransformationModel Interface
    • Kernel Class
    • KernelDensity Class
    • KernelDensityBandwidthEstimator Enumeration
    • KeyVariable Class
    • KeyVariable(T) Class
    • LinearRegressionModel Class
    • LinkFunction Class
    • LogisticRegressionMethod Enumeration
    • LogisticRegressionModel Class
    • MissingValueAction Enumeration
    • MissingValueException Class
    • Model Class
    • ModelExtensions Class
    • ModelFamily Class
    • ModelFitOptions Class
    • ModelInput Class
    • ModelInputCategory Enumeration
    • ModelInputFormat Enumeration
    • ModelInputGroup Class
    • ModelSerialization Enumeration
    • ModelStatus Enumeration
    • ModelTerm Class
    • ModelTermCollection Class
    • ModelTermKind Enumeration
    • MultipleMissingValueAction Enumeration
    • NearestCorrelationMatrixAlgorithm Enumeration
    • NonlinearRegressionModel Class
    • NumericalScale Class
    • NumericalVariable Class
    • NumericalVariable.NumericalFilters Structure
    • NumericalVariable.NumericalVariableTransforms Structure
    • Observation Structure
    • ObservationCollection Class
    • OneWayAnovaModel Class
    • OneWayRAnovaModel Class
    • Parameter Class
    • ParameterCollection Class
    • ParameterVector Class
    • PolynomialRegressionModel Class
    • RankTiebreaker Enumeration
    • RegressionModel Class
    • RegularizedRegressionModel Class
    • ScaleFittingMethod Enumeration
    • SeriesExtensions Class
    • SimpleRegressionKind Enumeration
    • SimpleRegressionModel Class
    • SortOrder Enumeration
    • SpecialBins Enumeration
    • Stats Class
    • StepwiseCriterion Enumeration
    • StepwiseOptions Class
    • StepwiseRegressionMethod Enumeration
    • SumsOfSquaresType Enumeration
    • TestOfHomogeneityOfVariances Enumeration
    • TestOfNormality Enumeration
    • TransformationModel Class
    • TransformedParameter Class
    • TwoWayAnovaModel Class
    • UnivariateModel Class
    • Variable Class
    • VariableCollection Class
    • WindowFilter Class
  • Variable Class
    • Variable Constructor
    • Properties
    • Methods
    • Fields
  • Properties
    • Aggregator Property
    • CountMissing Property
    • CountValid Property
    • Description Property
    • Filter Property
    • FormatString Property
    • IsSortable Property
    • IsSorted Property
    • Length Property
    • MissingValue Property
    • Name Property
    • SortOrder Property
    • UnfilteredLength Property
    • VariableCollection Property
  • Filter Property
VariableFilter Property Extreme Optimization Numerical Libraries for .NET Professional
Gets or sets the Filter associated with the current variable.

Namespace: Extreme.Statistics
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 6.0.16073.0 (6.0.16312.0)
Syntax

C#
VB
C++
F#
Copy
public Filter Filter { get; set; }
Public Property Filter As Filter
	Get
	Set
public:
property Filter^ Filter {
	Filter^ get ();
	void set (Filter^ value);
}
member Filter : Filter with get, set

Property Value

Type: Filter
Exceptions

ExceptionCondition
InvalidOperationException The property is set while the variable is a member of a VariableCollection.
DimensionMismatchException The length of the filter does not equal the number of observations of the variable.
Remarks

Use the Filter property to restrict calculations to those observations that match certain criteria. All operations, including descriptive statistics and regression analysis and the creation of statistical models, use only the filtered observations.

Most variables have a Filters property that provides easy access to methods that create filters based on simple criteria. Any filter whose length equals the number of observations of the variable can be used. Filter objects can be constructed from scratch, or combined with other filters.

A filter always operates on the entire set of observations. Setting the Filter property of a variable that had its Filter property set previously, replaces the current filter with the new value.

A filter can only be set for variables that are not a member of a VariableCollection. For variables that are contained in a collection, the filter should be applied to the collection as a whole.

Version Information

Numerical Libraries

Supported in: 5.x, 4.x
See Also

Reference

Variable Class
Extreme.Statistics Namespace

Copyright (c) 2004-2016 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2018, 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.