SinglePermutationMatrix Class - Extreme.Mathematics.LinearAlgebra

Introduction

Deployment Guide

Nuget packages

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

SinglePermutationMatrix Class

Extreme 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++

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

	Name	Description
	SinglePermutationMatrix(Int32)	Constructs a new SinglePermutationMatrix
	SinglePermutationMatrix(Permutation)	Constructs a new SinglePermutationMatrix

Top

Properties

	Name	Description
	ColumnCount	Gets the number of columns in the SingleMatrix. (Inherited from SingleMatrix.)
	Columns	Gets the ColumnCollection for this instance. (Inherited from SingleMatrix.)
	ElementOrder	Gets a value indicating the order in which the matrix elements are stored. (Inherited from SingleMatrix.)
	IsLowerTriangular	Gets a value that indicates if all components of the matrix above the main diagonal are zero. (Inherited from SingleMatrix.)
	IsSparse	Gets a value that indicates whether the matrix is sparse. (Overrides SingleMatrixIsSparse.)
	IsSymmetrical	Gets a value that indicates if the matrix is symmetrical about the main diagonal. (Inherited from SingleMatrix.)
	IsUnitDiagonal	Gets a value indicating whether all diagonal elements of this instance are equal to 1. (Inherited from SingleMatrix.)
	IsUpperTriangular	Gets a value that indicates if all components of the matrix below the main diagonal are zero. (Inherited from SingleMatrix.)
	ItemInt32, Range	Gets or sets the components of a row of this SingleMatrix. (Inherited from SingleMatrix.)
	ItemInt32, Int32	Gets or sets the specified element in this SingleMatrix. (Inherited from SingleMatrix.)
	ItemRange, Range	Gets or sets the components of a submatrix of this SingleMatrix. (Inherited from SingleMatrix.)
	ItemRange, Int32	Gets or sets the components of a column of this SingleMatrix. (Inherited from SingleMatrix.)
	NonzeroComponents	Gets a collection of the nonzero components of the matrix. (Inherited from SingleMatrix.)
	Permutation	Gets the Permutation represented by this permutation matrix.
	RowCount	Gets the number of rows in the SingleMatrix. (Inherited from SingleMatrix.)
	Rows	Gets the RowCollection for this instance. (Inherited from SingleMatrix.)

Top

Methods

	Name	Description
	AbsoluteMax	Returns the value of the component in this SingleMatrix that has the largest absolute value. (Inherited from SingleMatrix.)
	AbsoluteMin	Returns the value of the component in this SingleMatrix that has the smallest absolute value. (Inherited from SingleMatrix.)
	Add(Single)	Adds a constant to a matrix. (Inherited from SingleMatrix.)
	Add(TransposeOperation, TransposeOperation, Single, SingleMatrix)	Adds a multiple of a SingleMatrix to this SingleMatrix and returns the result. (Inherited from SingleMatrix.)
	AddProductToVector	Multiplies a vector by this SingleMatrix and stores the result in a second SingleVector. (Overrides SingleMatrixAddProductToVector(Single, SingleVector, TransposeOperation, Single, SingleDenseVector).)
	Apply(FuncSingle, Single)	Applies a function to the elements of a SingleMatrix. (Inherited from SingleMatrix.)
	ApplyToColumns	Applies a function to each column in a matrix and returns the result as a vector. (Inherited from SingleMatrix.)
	ApplyToRows	Applies a function to each column in a matrix and returns the result as a vector. (Inherited from SingleMatrix.)
	AsDenseMatrix	Returns this matrix as a SingleDenseMatrix. (Inherited from SingleMatrix.)
	AsGeneralMatrix	Obsolete. Returns this matrix as a SingleDenseMatrix. (Inherited from SingleMatrix.)
	Clone	Constructs a deep copy of this SingleMatrix. (Inherited from SingleMatrix.)
	CloneData	Gives this instance its own copy of its elements. (Inherited from SingleMatrix.)
	ComponentwiseDivide(SingleMatrix)	Divides the components of this instance by the corresponding components of another matrix. (Inherited from SingleMatrix.)
	ComponentwiseMultiply(SingleMatrix)	Multiplies the components of this instance by the corresponding components of another matrix. (Inherited from SingleMatrix.)
	CopyTo	Copies the components of this SingleMatrix to another matrix. (Inherited from SingleMatrix.)
	Equals(Object)	Determines whether the specified Object is equal to the current SingleMatrix. (Inherited from SingleMatrix.)
	Equals(SingleMatrix)	Determines whether the specified SingleMatrix is equal to the current SingleMatrix. (Inherited from SingleMatrix.)
	EstimateConditionNumber	Calculates an estimate for the condition number of this SingleMatrix. (Overrides SingleMatrixEstimateConditionNumber.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FrobeniusNorm	Returns the Frobenius norm of this SingleMatrix. (Inherited from SingleMatrix.)
	GetColumn(Int32)	Returns a column SingleVector for this instance that points at the specified column. (Inherited from SingleMatrix.)
	GetColumn(Int32, Range)	Returns a column SingleVector for this instance starting at the specified column and row and of the specified length. (Inherited from SingleMatrix.)
	GetColumn(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.)
	GetColumn(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.)
	GetColumnEnumerator	Obsolete. Gets an IEnumerator than can be used to enumerate the columns of this SingleMatrix. (Inherited from SingleMatrix.)
	GetColumnSums	Returns the sums of the components of each column of the matrix. (Inherited from SingleMatrix.)
	GetComponents	Obsolete. Gets the components of the vector. (Inherited from SingleMatrix.)
	GetComponents(MatrixElementOrder)	Obsolete. Gets the components of the vector. (Inherited from SingleMatrix.)
	GetConditionNumber	Calculates the condition number of this SingleMatrix. (Overrides SingleMatrixGetConditionNumber.)
	GetDeterminant	Calculates the determinant of this SingleMatrix. (Overrides SingleMatrixGetDeterminant.)
	GetDiagonal	Gets a vector view of the diagonal elements of this instance. (Inherited from SingleMatrix.)
	GetDiagonal(Int32)	Gets a vector view of the specified diagonal of this instance. (Inherited from SingleMatrix.)
	GetExponential	Computes the matrix exponential of a square matrix. (Inherited from SingleMatrix.)
	GetHashCode	Returns the hash code for this instance. (Inherited from SingleMatrix.)
	GetInverse	Calculates the inverse of this SingleMatrix. (Overrides SingleMatrixGetInverse.)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Inherited from SingleMatrix.)
	GetPseudoInverse	Calculates the Moore-Penrose pseudo-inverse of this SingleMatrix. (Overrides SingleMatrixGetPseudoInverse.)
	GetRow(Int32)	Returns a row SingleVector for this instance that points at the specified row. (Inherited from SingleMatrix.)
	GetRow(Int32, Range)	Returns a row SingleVector for this instance starting at the specified row and column and of the specified length. (Inherited from SingleMatrix.)
	GetRow(Int32, Int32, Int32)	Returns a row SingleVector for this instance over the specified range. (Inherited from SingleMatrix.)
	GetRow(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.)
	GetRowEnumerator	Obsolete. Returns an IEnumerator instance that allows you to enumerate the rows of this SingleMatrix. (Inherited from SingleMatrix.)
	GetRowSums	Returns the sums of the components of each row of the matrix. (Inherited from SingleMatrix.)
	GetSingularValues	Gets a vector containing the singular values of the matrix. (Inherited from SingleMatrix.)
	GetSubmatrix(Range, Range)	Gets a SingleMatrix that is a submatrix of this SingleMatrix. (Inherited from SingleMatrix.)
	GetSubmatrix(Range, Range, TransposeOperation)	Gets a SingleMatrix that is a submatrix of this SingleMatrix. (Inherited from SingleMatrix.)
	GetSubmatrix(Int32, Int32, Int32, Int32)	Gets a SingleMatrix that is a submatrix of this SingleMatrix. (Inherited from SingleMatrix.)
	GetSubmatrix(Int32, Int32, Int32, Int32, Int32, Int32, TransposeOperation)	Gets a SingleMatrix that is a submatrix of this SingleMatrix. (Inherited from SingleMatrix.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Gets the matrix component at the specified position. (Overrides SingleMatrixGetValue(Int32, Int32).)
	InfinityNorm	Returns the infinity norm of this SingleMatrix. (Inherited from SingleMatrix.)
	IsComponentWritable	Returns a value that indicates whether the value of the component at the specified row and column can be changed. (Overrides SingleMatrixIsComponentWritable(Int32, Int32).)
	IsSingular	Gets a value indicating whether this matrix is singular. (Overrides SingleMatrixIsSingular.)
	Max	Returns the value of the largest component in this SingleMatrix. (Inherited from SingleMatrix.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Min	Returns the value of the smallest component in this SingleMatrix. (Inherited from SingleMatrix.)
	Multiply(Single)	Multiplies this SingleMatrix by a scalar factor. (Inherited from SingleMatrix.)
	Multiply(MatrixOperationSide, TransposeOperation, TransposeOperation, SingleMatrix)	Multiplies this SingleMatrix by another matrix and returns the result. (Inherited from SingleMatrix.)
	NormInternal	Calculates a matrix norm. (Inherited from SingleMatrix.)
	OneNorm	Returns the 1-norm of this SingleMatrix. (Inherited from SingleMatrix.)
	PermuteColumns	Permutes the columns of the matrix using the specified Permutation. (Inherited from SingleMatrix.)
	PermuteRows	Permutes the rows of the matrix using the specified Permutation. (Inherited from SingleMatrix.)
	PermuteRowsAndColumns(Permutation)	Permutes the rows and columns of the matrix using the specified Permutation. (Inherited from SingleMatrix.)
	PermuteRowsAndColumns(Permutation, Permutation)	Permutes the rows and columns of the matrix using the specified row and column Permutation. (Inherited from SingleMatrix.)
	Rank	Returns the numerical rank of a matrix. (Inherited from SingleLinearTransformation.)
	Rank(Single)	Returns the numerical rank of a matrix using the specified tolerance. (Overrides SingleMatrixRank(Single).)
	ScaleColumns	Scales the columns of the matrix by the values specified by a vector. (Inherited from SingleMatrix.)
	ScaleRows	Scales the rows of the matrix by the values specified by a vector. (Inherited from SingleMatrix.)
	SetToZero	Sets all elements of the matrix to zero. (Inherited from SingleMatrix.)
	SetValue(Single)	Sets all elements of the matrix to the specified value. (Inherited from SingleMatrix.)
	SetValue(Single, Int32, Int32)	Sets the matrix component at the specified position to the specified value. (Overrides SingleMatrixSetValue(Single, Int32, Int32).)
	ShallowCopy	Makes a shallow copy of this SingleMatrix. (Inherited from SingleMatrix.)
	Solve(SingleMatrix)	Solves the system of linear equations for the specified right-hand side SingleMatrix. (Inherited from SingleLinearTransformation.)
	Solve(SingleVector)	Solves the system of linear equations for the specified right-hand side SingleVector. (Inherited from SingleLinearTransformation.)
	Solve(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).)
	Solve(SingleDenseVector, Boolean)	Solves the system of simultaneous linear equations for the specified right-hand side SingleVector. (Overrides SingleMatrixSolve(SingleDenseVector, Boolean).)
	SolveTranspose(SingleMatrix)	Solves the transposed system of linear equations for the specified right-hand side SingleMatrix. (Inherited from SingleLinearTransformation.)
	SolveTranspose(SingleVector)	Solves the system of linear equations for the specified right-hand side SingleVector. (Inherited from SingleLinearTransformation.)
	SolveTranspose(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).)
	SolveTranspose(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).)
	SwapColumns	Swaps the columns with the specified indices. (Inherited from SingleMatrix.)
	SwapRows	Swaps the rows with the specified indices. (Inherited from SingleMatrix.)
	ToArray	Gets the components of the vector. (Inherited from SingleMatrix.)
	ToArray(MatrixElementOrder)	Gets the components of the vector. (Overrides SingleMatrixToArray(MatrixElementOrder).)
	ToDenseMatrix	Makes a copy of this instance and returns it as a SingleDenseMatrix. (Inherited from SingleMatrix.)
	ToDoublePrecision	Returns a double-precision equivalent of the matrix. (Overrides SingleMatrixToDoublePrecision.)
	ToGeneralMatrix	Obsolete. Makes a copy of this instance and returns it as a SingleDenseMatrix. (Inherited from SingleMatrix.)
	ToString	Returns a String representation of this SingleMatrix. (Inherited from SingleMatrix.)
	ToString(String)	Returns a String representation of this SingleMatrix. (Inherited from SingleMatrix.)
	ToString(String, IFormatProvider)	Returns a String representation of this SingleMatrix. (Inherited from SingleMatrix.)
	Trace	Gets the sum of the diagonal elements of this SingleMatrix. (Inherited from SingleMatrix.)
	Transpose	Returns the transpose of this instance. (Overrides SingleMatrixTranspose.)
	TwoNorm	Returns the two-norm of this SingleMatrix. (Inherited from SingleMatrix.)
	UnscaleColumns	Scales the columns of the matrix by the inverse of the values specified by a vector. (Inherited from SingleMatrix.)
	UnscaleRows	Scales the rows of the matrix by the inverse of the values specified by a vector. (Inherited from SingleMatrix.)
	ValidateAddProductToVector	Validates the parameters of a call to AddProductToVector(Single, SingleVector, TransposeOperation, Single, SingleDenseVector) (Inherited from SingleMatrix.)

Top

Operators

	Name	Description
	(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

Reference

Extreme.Mathematics.LinearAlgebra Namespace

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.