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
Nuget packages
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
SinglePermutationMatrix ClassExtreme Optimization Numerical Libraries for .NET Professional
Represents a permutation matrix.
Inheritance Hierarchy

SystemObject
  Extreme.Mathematics.LinearAlgebraSingleLinearTransformation
    Extreme.MathematicsSingleMatrix
      Extreme.Mathematics.LinearAlgebraSinglePermutationMatrix

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics.Version4x.Net40 (in Extreme.Numerics.Version4x.Net40.dll) Version: 4.2.11333.0 (5.0.12317.0)
Syntax

C#
VB
C++
F#
Copy
public class SinglePermutationMatrix : SingleMatrix
Public Class SinglePermutationMatrix
	Inherits SingleMatrix
public ref class SinglePermutationMatrix : public SingleMatrix
type SinglePermutationMatrix =  
    class
        inherit SingleMatrix
    end

The SinglePermutationMatrix type exposes the following members.

Constructors

  NameDescription
Public methodSinglePermutationMatrix(Int32)
Constructs a new SinglePermutationMatrix
Public methodSinglePermutationMatrix(Permutation)
Constructs a new SinglePermutationMatrix
Top
Properties

  NameDescription
Public propertyColumnCount
Gets the number of columns in the SingleMatrix.
(Inherited from SingleMatrix.)
Public propertyColumns
Gets the ColumnCollection for this instance.
(Inherited from SingleMatrix.)
Public propertyElementOrder
Gets a value indicating the order in which the matrix elements are stored.
(Inherited from SingleMatrix.)
Public propertyIsLowerTriangular
Gets a value that indicates if all components of the matrix above the main diagonal are zero.
(Inherited from SingleMatrix.)
Public propertyIsSparse
Gets a value that indicates whether the matrix is sparse.
(Overrides SingleMatrixIsSparse.)
Public propertyIsSymmetrical
Gets a value that indicates if the matrix is symmetrical about the main diagonal.
(Inherited from SingleMatrix.)
Public propertyIsUnitDiagonal
Gets a value indicating whether all diagonal elements of this instance are equal to 1.
(Inherited from SingleMatrix.)
Public propertyIsUpperTriangular
Gets a value that indicates if all components of the matrix below the main diagonal are zero.
(Inherited from SingleMatrix.)
Public propertyItemInt32, Range
Gets or sets the components of a row of this SingleMatrix.
(Inherited from SingleMatrix.)
Public propertyItemInt32, Int32
Gets or sets the specified element in this SingleMatrix.
(Inherited from SingleMatrix.)
Public propertyItemRange, Range
Gets or sets the components of a submatrix of this SingleMatrix.
(Inherited from SingleMatrix.)
Public propertyItemRange, Int32
Gets or sets the components of a column of this SingleMatrix.
(Inherited from SingleMatrix.)
Public propertyNonzeroComponents
Gets a collection of the nonzero components of the matrix.
(Inherited from SingleMatrix.)
Public propertyPermutation
Gets the Permutation represented by this permutation matrix.
Public propertyRowCount
Gets the number of rows in the SingleMatrix.
(Inherited from SingleMatrix.)
Public propertyRows
Gets the RowCollection for this instance.
(Inherited from SingleMatrix.)
Top
Methods

  NameDescription
Public methodAbsoluteMax
Returns the value of the component in this SingleMatrix that has the largest absolute value.
(Inherited from SingleMatrix.)
Public methodAbsoluteMin
Returns the value of the component in this SingleMatrix that has the smallest absolute value.
(Inherited from SingleMatrix.)
Public methodAdd(Single)
Adds a constant to a matrix.
(Inherited from SingleMatrix.)
Public methodAdd(TransposeOperation, TransposeOperation, Single, SingleMatrix)
Adds a multiple of a SingleMatrix to this SingleMatrix and returns the result.
(Inherited from SingleMatrix.)
Public methodAddProductToVector
Multiplies a vector by this SingleMatrix and stores the result in a second SingleVector.
(Overrides SingleMatrixAddProductToVector(Single, SingleVector, TransposeOperation, Single, SingleDenseVector).)
Public methodApply(FuncSingle, Single)
Applies a function to the elements of a SingleMatrix.
(Inherited from SingleMatrix.)
Public methodApplyToColumns
Applies a function to each column in a matrix and returns the result as a vector.
(Inherited from SingleMatrix.)
Public methodApplyToRows
Applies a function to each column in a matrix and returns the result as a vector.
(Inherited from SingleMatrix.)
Public methodAsDenseMatrix
Returns this matrix as a SingleDenseMatrix.
(Inherited from SingleMatrix.)
Public methodAsGeneralMatrix Obsolete.
Returns this matrix as a SingleDenseMatrix.
(Inherited from SingleMatrix.)
Public methodClone
Constructs a deep copy of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodCloneData
Gives this instance its own copy of its elements.
(Inherited from SingleMatrix.)
Public methodComponentwiseDivide(SingleMatrix)
Divides the components of this instance by the corresponding components of another matrix.
(Inherited from SingleMatrix.)
Public methodComponentwiseMultiply(SingleMatrix)
Multiplies the components of this instance by the corresponding components of another matrix.
(Inherited from SingleMatrix.)
Public methodCopyTo
Copies the components of this SingleMatrix to another matrix.
(Inherited from SingleMatrix.)
Public methodEquals(Object)
Determines whether the specified Object is equal to the current SingleMatrix.
(Inherited from SingleMatrix.)
Public methodEquals(SingleMatrix)
Determines whether the specified SingleMatrix is equal to the current SingleMatrix.
(Inherited from SingleMatrix.)
Public methodEstimateConditionNumber
Calculates an estimate for the condition number of this SingleMatrix.
(Overrides SingleMatrixEstimateConditionNumber.)
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 methodFrobeniusNorm
Returns the Frobenius norm of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodGetColumn(Int32)
Returns a column SingleVector for this instance that points at the specified column.
(Inherited from SingleMatrix.)
Public methodGetColumn(Int32, Range)
Returns a column SingleVector for this instance starting at the specified column and row and of the specified length.
(Inherited from SingleMatrix.)
Public methodGetColumn(Int32, Int32, Int32)
Returns a column SingleVector for this instance starting at the specified column and row and of the specified length.
(Inherited from SingleMatrix.)
Public methodGetColumn(Int32, Int32, Int32, Int32)
Returns a column SingleVector for this instance starting at the specified column and row and of the specified length.
(Inherited from SingleMatrix.)
Public methodGetColumnEnumerator Obsolete.
Gets an IEnumerator than can be used to enumerate the columns of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodGetColumnSums
Returns the sums of the components of each column of the matrix.
(Inherited from SingleMatrix.)
Public methodGetComponents Obsolete.
Gets the components of the vector.
(Inherited from SingleMatrix.)
Public methodGetComponents(MatrixElementOrder) Obsolete.
Gets the components of the vector.
(Inherited from SingleMatrix.)
Public methodGetConditionNumber
Calculates the condition number of this SingleMatrix.
(Overrides SingleMatrixGetConditionNumber.)
Public methodGetDeterminant
Calculates the determinant of this SingleMatrix.
(Overrides SingleMatrixGetDeterminant.)
Public methodGetDiagonal
Gets a vector view of the diagonal elements of this instance.
(Inherited from SingleMatrix.)
Public methodGetDiagonal(Int32)
Gets a vector view of the specified diagonal of this instance.
(Inherited from SingleMatrix.)
Public methodGetExponential
Computes the matrix exponential of a square matrix.
(Inherited from SingleMatrix.)
Public methodGetHashCode
Returns the hash code for this instance.
(Inherited from SingleMatrix.)
Public methodGetInverse
Calculates the inverse of this SingleMatrix.
(Overrides SingleMatrixGetInverse.)
Public methodGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from SingleMatrix.)
Public methodGetPseudoInverse
Calculates the Moore-Penrose pseudo-inverse of this SingleMatrix.
(Overrides SingleMatrixGetPseudoInverse.)
Public methodGetRow(Int32)
Returns a row SingleVector for this instance that points at the specified row.
(Inherited from SingleMatrix.)
Public methodGetRow(Int32, Range)
Returns a row SingleVector for this instance starting at the specified row and column and of the specified length.
(Inherited from SingleMatrix.)
Public methodGetRow(Int32, Int32, Int32)
Returns a row SingleVector for this instance over the specified range.
(Inherited from SingleMatrix.)
Public methodGetRow(Int32, Int32, Int32, Int32)
Returns a row SingleVector for this instance starting at the specified row and column and of the specified length.
(Inherited from SingleMatrix.)
Public methodGetRowEnumerator Obsolete.
Returns an IEnumerator instance that allows you to enumerate the rows of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodGetRowSums
Returns the sums of the components of each row of the matrix.
(Inherited from SingleMatrix.)
Public methodGetSingularValues
Gets a vector containing the singular values of the matrix.
(Inherited from SingleMatrix.)
Public methodGetSubmatrix(Range, Range)
Gets a SingleMatrix that is a submatrix of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodGetSubmatrix(Range, Range, TransposeOperation)
Gets a SingleMatrix that is a submatrix of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodGetSubmatrix(Int32, Int32, Int32, Int32)
Gets a SingleMatrix that is a submatrix of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodGetSubmatrix(Int32, Int32, Int32, Int32, Int32, Int32, TransposeOperation)
Gets a SingleMatrix that is a submatrix of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Gets the matrix component at the specified position.
(Overrides SingleMatrixGetValue(Int32, Int32).)
Public methodInfinityNorm
Returns the infinity norm of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodIsComponentWritable
Returns a value that indicates whether the value of the component at the specified row and column can be changed.
(Overrides SingleMatrixIsComponentWritable(Int32, Int32).)
Public methodIsSingular
Gets a value indicating whether this matrix is singular.
(Overrides SingleMatrixIsSingular.)
Public methodMax
Returns the value of the largest component in this SingleMatrix.
(Inherited from SingleMatrix.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMin
Returns the value of the smallest component in this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodMultiply(Single)
Multiplies this SingleMatrix by a scalar factor.
(Inherited from SingleMatrix.)
Public methodMultiply(MatrixOperationSide, TransposeOperation, TransposeOperation, SingleMatrix)
Multiplies this SingleMatrix by another matrix and returns the result.
(Inherited from SingleMatrix.)
Protected methodNormInternal
Calculates a matrix norm.
(Inherited from SingleMatrix.)
Public methodOneNorm
Returns the 1-norm of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodPermuteColumns
Permutes the columns of the matrix using the specified Permutation.
(Inherited from SingleMatrix.)
Public methodPermuteRows
Permutes the rows of the matrix using the specified Permutation.
(Inherited from SingleMatrix.)
Public methodPermuteRowsAndColumns(Permutation)
Permutes the rows and columns of the matrix using the specified Permutation.
(Inherited from SingleMatrix.)
Public methodPermuteRowsAndColumns(Permutation, Permutation)
Permutes the rows and columns of the matrix using the specified row and column Permutation.
(Inherited from SingleMatrix.)
Public methodRank
Returns the numerical rank of a matrix.
(Inherited from SingleLinearTransformation.)
Public methodRank(Single)
Returns the numerical rank of a matrix using the specified tolerance.
(Overrides SingleMatrixRank(Single).)
Public methodScaleColumns
Scales the columns of the matrix by the values specified by a vector.
(Inherited from SingleMatrix.)
Public methodScaleRows
Scales the rows of the matrix by the values specified by a vector.
(Inherited from SingleMatrix.)
Public methodSetToZero
Sets all elements of the matrix to zero.
(Inherited from SingleMatrix.)
Public methodSetValue(Single)
Sets all elements of the matrix to the specified value.
(Inherited from SingleMatrix.)
Public methodSetValue(Single, Int32, Int32)
Sets the matrix component at the specified position to the specified value.
(Overrides SingleMatrixSetValue(Single, Int32, Int32).)
Public methodShallowCopy
Makes a shallow copy of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodSolve(SingleMatrix)
Solves the system of linear equations for the specified right-hand side SingleMatrix.
(Inherited from SingleLinearTransformation.)
Public methodSolve(SingleVector)
Solves the system of linear equations for the specified right-hand side SingleVector.
(Inherited from SingleLinearTransformation.)
Public methodSolve(SingleDenseMatrix, Boolean)
Solves the system of simultaneous linear equations for the specified right-hand side SingleDenseMatrix and overwrites the right-hand side with the solution.
(Overrides SingleMatrixSolve(SingleDenseMatrix, Boolean).)
Public methodSolve(SingleDenseVector, Boolean)
Solves the system of simultaneous linear equations for the specified right-hand side SingleVector.
(Overrides SingleMatrixSolve(SingleDenseVector, Boolean).)
Public methodSolveTranspose(SingleMatrix)
Solves the transposed system of linear equations for the specified right-hand side SingleMatrix.
(Inherited from SingleLinearTransformation.)
Public methodSolveTranspose(SingleVector)
Solves the system of linear equations for the specified right-hand side SingleVector.
(Inherited from SingleLinearTransformation.)
Public methodSolveTranspose(SingleDenseMatrix, Boolean)
Solves the transposed system of linear equations for the specified right-hand side SingleDenseMatrix and optionally overwrites the right-hand side with the solution.
(Overrides SingleMatrixSolveTranspose(SingleDenseMatrix, Boolean).)
Public methodSolveTranspose(SingleDenseVector, Boolean)
Solves the transposed system of linear equations for the specified right-hand side DenseVector and optionally overwrites the right-hand side with the solution.
(Overrides SingleMatrixSolveTranspose(SingleDenseVector, Boolean).)
Public methodSwapColumns
Swaps the columns with the specified indices.
(Inherited from SingleMatrix.)
Public methodSwapRows
Swaps the rows with the specified indices.
(Inherited from SingleMatrix.)
Public methodToArray
Gets the components of the vector.
(Inherited from SingleMatrix.)
Public methodToArray(MatrixElementOrder)
Gets the components of the vector.
(Overrides SingleMatrixToArray(MatrixElementOrder).)
Public methodToDenseMatrix
Makes a copy of this instance and returns it as a SingleDenseMatrix.
(Inherited from SingleMatrix.)
Public methodToDoublePrecision
Returns a double-precision equivalent of the matrix.
(Overrides SingleMatrixToDoublePrecision.)
Public methodToGeneralMatrix Obsolete.
Makes a copy of this instance and returns it as a SingleDenseMatrix.
(Inherited from SingleMatrix.)
Public methodToString
Returns a String representation of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodToString(String)
Returns a String representation of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodToString(String, IFormatProvider)
Returns a String representation of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodTrace
Gets the sum of the diagonal elements of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodTranspose
Returns the transpose of this instance.
(Overrides SingleMatrixTranspose.)
Public methodTwoNorm
Returns the two-norm of this SingleMatrix.
(Inherited from SingleMatrix.)
Public methodUnscaleColumns
Scales the columns of the matrix by the inverse of the values specified by a vector.
(Inherited from SingleMatrix.)
Public methodUnscaleRows
Scales the rows of the matrix by the inverse of the values specified by a vector.
(Inherited from SingleMatrix.)
Protected methodValidateAddProductToVector
Validates the parameters of a call to AddProductToVector(Single, SingleVector, TransposeOperation, Single, SingleDenseVector)
(Inherited from SingleMatrix.)
Top
Operators

  NameDescription
Public operatorStatic member(PermutationMatrix to SinglePermutationMatrix)
Converts a double-precision permutation matrix to its single-precision equivalent.
Top
Remarks

Use the SinglePermutationMatrix class to represent, in compact form, a matrix that can be used to permute the rows or columns of a vector or matrix.

A permutation matrix is an orthogonal matrix that has a 1 at exactly one position on each row or column, and is zero everywhere else.

Version Information

Numerical Libraries

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

Reference

Extreme.Mathematics.LinearAlgebra Namespace

Copyright (c) 2004-2017 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

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