Extreme Optimization™: Complexity made simple.

Numerical Components
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
    • 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
    • Contact us
Introduction
Deployment Guide
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 Statistics Library User's GuideStatistics Library User's Guide
Expand ReferenceReference
  • Home
    • Features
    • Solutions
    • Documentation
    • QuickStart Samples
    • Sample Applications
    • Downloads
    • Technical Support
    • Download trial
    • How to buy
    • Blog
    • Company
    • Resources
  • Documentation
    • Introduction
    • Deployment Guide
    • Using Parallelism
    • Mathematics Library User's Guide
    • Vector and Matrix Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Reference
    • Extreme.Mathematics Namespace
    • Extreme.Mathematics.Algorithms Namespace
    • Extreme.Mathematics.Calculus Namespace
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations Namespace
    • Extreme.Mathematics.Curves Namespace
    • Extreme.Mathematics.Curves.Nonlinear Namespace
    • Extreme.Mathematics.EquationSolvers Namespace
    • Extreme.Mathematics.Generic Namespace
    • Extreme.Mathematics.Generic.LinearAlgebra Namespace
    • Extreme.Mathematics.Generic.LinearAlgebra.Providers Namespace
    • Extreme.Mathematics.LinearAlgebra Namespace
    • Extreme.Mathematics.LinearAlgebra.Complex Namespace
    • Extreme.Mathematics.LinearAlgebra.Complex.Decompositions Namespace
    • Extreme.Mathematics.LinearAlgebra.IO Namespace
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers Namespace
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners Namespace
    • Extreme.Mathematics.LinearAlgebra.Providers Namespace
    • Extreme.Mathematics.LinearAlgebra.Sparse Namespace
    • Extreme.Mathematics.Optimization Namespace
    • Extreme.Mathematics.Optimization.LineSearches Namespace
    • Extreme.Mathematics.SignalProcessing Namespace
    • Extreme.Statistics Namespace
    • Extreme.Statistics.Distributions Namespace
    • Extreme.Statistics.IO Namespace
    • Extreme.Statistics.Multivariate Namespace
    • Extreme.Statistics.Random Namespace
    • Extreme.Statistics.Tests Namespace
    • Extreme.Statistics.TimeSeriesAnalysis Namespace
  • Extreme.Mathematics.LinearAlgebra Namespace
    • BandMatrix Class
    • BandVector Class
    • CholeskyDecomposition Class
    • CloningMethod Enumeration
    • ColumnCollection Structure
    • ComponentReadOnlyException Class
    • ConstantMatrix Class
    • ConstantVector Class
    • Decomposition Class
    • DenseMatrix Class
    • DenseVector Class
    • DiagonalMatrix Class
    • EigenvalueDecomposition Class
    • IDoubleStorage Interface
    • ILeastSquaresSolver Interface
    • IndexedVector Class
    • IndexValuePair Structure
    • IResizableMatrix Interface
    • ISingleLeastSquaresSolver Interface
    • ISingleResizableMatrix Interface
    • ISingleStorage Interface
    • Kernel Class
    • LeastSquaresSolutionMethod Enumeration
    • LeastSquaresSolver Class
    • LinearOperator Class
    • LUDecomposition Class
    • MatrixNotPositiveDefiniteException Class
    • MatrixSingularException Class
    • MatrixStructure Enumeration
    • MatrixView Class
    • NonNegativeMatrixFactorization Class
    • NonsymmetricEigenvalueDecomposition Class
    • PermutationMatrix Class
    • PivotVector Structure
    • QRDecomposition Class
    • Range Structure
    • RowCollection Structure
    • RowColumnValueTriplet Structure
    • SingleBandCholeskyDecomposition Class
    • SingleBandLUDecomposition Class
    • SingleBandMatrix Class
    • SingleBandVector Class
    • SingleBandVector.BandVectorEnumerator Structure
    • SingleCholeskyDecomposition Class
    • SingleColumnCollection Structure
    • SingleConstantMatrix Class
    • SingleConstantVector Class
    • SingleDecomposition Class
    • SingleDenseMatrix Class
    • SingleDenseVector Class
    • SingleDiagonalMatrix Class
    • SingleEigenvalueDecomposition Class
    • SingleIndexedVector Class
    • SingleIndexValuePair Structure
    • SingleKernel Class
    • SingleLeastSquaresSolver Class
    • SingleLinearTransformation Class
    • SingleLUDecomposition Class
    • SingleMatrixView Class
    • SinglePermutationMatrix Class
    • SingleQRDecomposition Class
    • SingleRowCollection Structure
    • SingleRowColumnValueTriplet Structure
    • SingleSingularValueDecomposition Class
    • SingleSparseLUDecomposition Class
    • SingleSparseMatrix Class
    • SingleSparseVector Class
    • SingleSymmetricEigenvalueDecomposition Class
    • SingleSymmetricMatrix Class
    • SingleTriangularMatrix Class
    • SingularValueDecomposition Class
    • SingularValueDecompositionFactors Enumeration
    • SparseCompressedColumnMatrix Class
    • SparseMatrix Class
    • SparseVector Class
    • SymmetricEigenvalueDecomposition Class
    • SymmetricMatrix Class
    • TriangularMatrix Class
  • SparseMatrix Class
    • Members
    • Constructors
    • Methods
    • Properties
  • Members
Collapse image Expand Image Copy image CopyHover image
                






SparseMatrix Members

SparseMatrix Class Constructors Methods Properties See Also 

The SparseMatrix type exposes the following members.

Constructors

  Name Description
Protected method SparseMatrix Overloaded.

Methods

  Name Description
Public method AbsoluteMax
Returns the value of the component in this matrix that has the largest absolute value.
(Inherited from Matrix.)
Public method AbsoluteMin
Returns the value of the component in this matrix that has the smallest absolute value.
(Inherited from Matrix.)
Public method Add Overloaded.
Public method AddAt
Adds a value to the component at the specified location.
Public method AddProductToVector
Multiplies a Vector by this Matrix and stores the result in a second vector of type DenseVector.
(Inherited from Matrix.)
Public method Apply
Applies a function to the elements of a matrix.
(Inherited from Matrix.)
Public method ApplyToColumns Overloaded.
Public method ApplyToRows Overloaded.
Public method AsDenseMatrix
Returns this matrix as a dense matrix.
(Inherited from Matrix.)
Public method AsGeneralMatrix Obsolete.
Returns this matrix as a dense matrix.
(Inherited from Matrix.)
Public method Clone Overloaded.
Public method CloneData
Gives this instance its own copy of its elements.
(Inherited from Matrix.)
Public method CloneShape
Creates a new matrix that has the same number of rows and columns and optionally preserves the writable structure.
(Inherited from Matrix.)
Public method ComponentwiseDivide
Divides the components of this instance by the corresponding components of another matrix.
(Inherited from Matrix.)
Public method Static member ComponentwiseMultiply Overloaded.
Public method CopyTo
Copies the components of this matrix to another matrix.
(Inherited from Matrix.)
Public method DivideAt
Divides the component at the specified location by a value.
Public method Equals Overloaded.
Public method EstimateConditionNumber
Calculates an estimate for the condition number of this matrix.
(Inherited from Matrix.)
Public method ExtractTriangle
Constructs an upper or lower triangular sparse matrix from a general sparse matrix.
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public method FrobeniusNorm
Returns the Frobenius norm of this matrix.
(Inherited from Matrix.)
Public method GetCholeskyDecomposition Overloaded.
Public method GetColumn Overloaded.
Returns a column or part of a column of this Matrix.
Public method GetColumnEnumerator Obsolete.
Gets an IEnumerator than can be used to enumerate the columns of this Matrix.
(Inherited from Matrix.)
Public method GetColumnSums
Returns the sums of the components of each column of the matrix.
(Overrides Matrix..::..GetColumnSums()()()().)
Public method GetComponents Overloaded.
Public method GetConditionNumber
Calculates the condition number of this matrix.
(Inherited from Matrix.)
Public method GetDeterminant
Calculates the determinant of this matrix.
(Overrides Matrix..::..GetDeterminant()()()().)
Public method GetDiagonal Overloaded.
Public method GetEigenvalueDecomposition Overloaded.
Public method GetExponential
Computes the matrix exponential of a square matrix.
(Inherited from Matrix.)
Public method GetHashCode Overloaded.
Public method GetInverse Overloaded.
Public method GetLUDecomposition Overloaded.
Public method GetNonzeroComponents
Returns the nonzero components
Public method GetObjectData
Populates a SerializationInfo with the values needed to serialize the target object.
(Inherited from Matrix.)
Public method GetParallelColumnEnumerator Obsolete.
Returns a Partitioner instance that allows you to enumerate the columns of this Matrix in parallel.
(Inherited from Matrix.)
Public method GetParallelRowEnumerator Obsolete.
Returns a Partitioner instance that allows you to enumerate the rows of this Matrix in parallel.
(Inherited from Matrix.)
Public method GetPseudoInverse
Calculates the Moore-Penrose pseudo-inverse of this matrix.
(Inherited from Matrix.)
Public method GetQRDecomposition Overloaded.
Public method GetRow Overloaded.
Returns a row or part of a row of this Matrix.
Public method GetRowEnumerator Obsolete.
Returns an IEnumerator instance that allows you to enumerate the rows of this Matrix.
(Inherited from Matrix.)
Public method GetRowSums
Returns the sums of the components of each row of the matrix.
(Overrides Matrix..::..GetRowSums()()()().)
Public method GetSingularValueDecomposition Overloaded.
Public method GetSingularValues
Gets a vector containing the singular values of the matrix.
(Inherited from Matrix.)
Public method GetSubmatrix Overloaded.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method GetValue
Gets the matrix component at the specified position.
(Overrides Matrix..::..GetValue(Int32, Int32).)
Protected method IncrementNonzeroCount
Called by inheritors to increment the number of nonzero components by the specified amount.
Public method InfinityNorm
Returns the infinity norm of this matrix.
(Inherited from Matrix.)
Public method InsertClique
Inserts a two-dimensional set of values at the specified positions in the sparse matrix.
Public method InsertColumn
Inserts a set of values at the specified column in the sparse matrix.
Public method InsertEntries
Inserts a set of values at the specified positions in the sparse matrix.
Public method InsertEntry
Inserts a value at the specified position in the sparse matrix.
Public method InsertRow
Inserts a set of values at the specified row in the sparse matrix.
Public method IsComponentWritable
Returns a value that indicates whether the value of the component at the specified row and column can be changed.
(Inherited from Matrix.)
Public method IsSingular
Gets a value indicating whether this matrix is singular.
(Inherited from Matrix.)
Public method Max
Returns the value of the largest component in this matrix.
(Inherited from Matrix.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Min
Returns the value of the smallest component in this matrix.
(Inherited from Matrix.)
Public method Multiply Overloaded.
Public method MultiplyAt
Multiplies the component at the specified location by a value.
Public method MultiplyTranspose Overloaded.
Protected method NormInternal
Calculates a matrix norm.
(Inherited from Matrix.)
Public method OneNorm
Returns the 1-norm of this matrix.
(Inherited from Matrix.)
Public method PermuteColumns
Permutes the columns of the matrix using the specified Permutation.
(Inherited from Matrix.)
Public method PermuteRows
Permutes the rows of the matrix using the specified Permutation.
(Inherited from Matrix.)
Public method PermuteRowsAndColumns Overloaded.
Public method Rank Overloaded.
Returns the numerical rank of the matrix.
Public method ScaleColumns
Scales the columns of the matrix by the values specified by a vector.
(Inherited from Matrix.)
Public method ScaleRows
Scales the rows of the matrix by the values specified by a vector.
(Inherited from Matrix.)
Public method SetToZero
Sets all elements of the matrix to zero.
(Inherited from Matrix.)
Public method SetValue Overloaded.
Public method ShallowCopy
Makes a shallow copy of this matrix.
(Inherited from Matrix.)
Public method Solve Overloaded.
Solves the system of simultaneous linear equations represented by this instance.
Public method SolveTo
Solves the system for the specified right-hand side.
(Inherited from LinearOperator.)
Public method SolveTranspose Overloaded.
Solves the transposed system of simultaneous linear equations represented by this instance.
Public method SolveTransposeTo
Solves the transposed system for the specified right-hand side.
(Inherited from LinearOperator.)
Public method SortColumns Overloaded.
Public method SortRows Overloaded.
Protected method SparseGetValue
Gets the matrix component at the specified position.
Protected method SparseSetValue
Sets the matrix component at the specified position to the specified value.
Public method SubtractAt
Subtracts a value from the component at the specified location.
Public method SwapColumns
Swaps the columns with the specified indices.
(Inherited from Matrix.)
Public method SwapRows
Interchanges the specified rows of the matrix.
(Overrides Matrix..::..SwapRows(Int32, Int32).)
Public method ToArray Overloaded.
Public method ToDenseMatrix
Makes a copy of this instance and returns it as a dense matrix.
(Inherited from Matrix.)
Public method ToGeneralMatrix Obsolete.
Makes a copy of this instance and returns it as a dense matrix.
(Inherited from Matrix.)
Public method ToString Overloaded.
Public method Trace
Gets the sum of the diagonal elements of this matrix.
(Inherited from Matrix.)
Public method Transpose
Returns the transpose of this instance.
(Inherited from Matrix.)
Public method TwoNorm
Returns the two-norm of this matrix.
(Inherited from Matrix.)
Public method UnscaleColumns
Scales the columns of the matrix by the inverse of the values specified by a vector.
(Inherited from Matrix.)
Public method UnscaleRows
Scales the rows of the matrix by the inverse of the values specified by a vector.
(Inherited from Matrix.)

Properties

  Name Description
Public property ColumnCount
Gets the number of columns in the matrix.
(Inherited from Matrix.)
Public property Columns
Gets the ColumnCollection for this instance.
(Inherited from Matrix.)
Public property ColumnwiseComponents
Enumerates the components of the matrix column by column.
(Inherited from Matrix.)
Public property DiagonalMode
Gets a value that indicates whether the diagonal elements of a triangular sparse matrix are all equal to 1.
Public property ElementOrder
Gets a value indicating the order in which the matrix elements are stored.
(Inherited from Matrix.)
Public property FillFactor
Gets the fraction of nonzero components in the matrix.
Public property IsLowerTriangular
Gets a value that indicates if all components of the matrix above the main diagonal are zero.
(Inherited from Matrix.)
Public property IsSparse
Gets a value that indicates whether the matrix is sparse.
(Overrides Matrix..::..IsSparse.)
Public property IsSymmetrical
Gets a value that indicates if the matrix is symmetrical about the main diagonal.
(Inherited from Matrix.)
Public property IsUnitDiagonal
Gets a value indicating whether all diagonal elements of this instance are equal to 1.
(Overrides Matrix..::..IsUnitDiagonal.)
Public property IsUpperTriangular
Gets a value that indicates if all components of the matrix below the main diagonal are zero.
(Inherited from Matrix.)
Public property Item Overloaded.
Public property NonzeroComponents
Gets a collection of the nonzero components of the matrix.
(Inherited from Matrix.)
Public property NonzeroCount
Gets the number of nonzero components in the matrix.
Public property RowCount
Gets the number of rows in the matrix.
(Inherited from Matrix.)
Public property Rows
Gets the RowCollection for this instance.
(Inherited from Matrix.)
Public property RowwiseComponents
Enumerates the components of the matrix column by column.
(Inherited from Matrix.)
Public property Structure
Gets a value that indicates the structure of the sparse matrix.
Public property TriangleMode
Gets a value that indicates whether a TriangularMatrix is upper or lower triangular.
Public property WritableComponents
Enumerates the writable components of the matrix column by column.
(Inherited from Matrix.)

See Also

SparseMatrix Class
Extreme.Mathematics.LinearAlgebra Namespace

Send comments on this topic to support@extremeoptimization.com

Copyright (c) 2004-2011 ExoAnalytics Inc.

Copyright © 2003-2013, 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.