DimensionMismatchException Class

Represents an exception that is thrown when the dimensions of a matrix or vector are not compatible for the requested operation.

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4
C#
[SerializableAttribute]
public class DimensionMismatchException : ArgumentException
Inheritance
Object  →  Exception  →  SystemException  →  ArgumentException  →  DimensionMismatchException

Remarks

There are many reasons why a DimensionMismatchException may be thrown. In every case, the dimensions of some or all of the Vector<T> or Matrix<T> arguments involved in an operation are not compatible. Some examples of requirements that may be violated, resulting in a DimensionMismatchException, are:

  • A method requires a Matrix<T> to be square. The matrix that was supplied is rectangular.
  • An operation on two Vector<T> objects requires that the two vectors have the same length. Most operations on vectors have this requirement.
  • A multiplication of a Matrix<T> and a Vector<T> requires that either the number of rows or the number of columns in the matrix equals the length of the vector.
  • A multiplication of two matrices requires that the 'inner' dimensions are the same.
.

A number of properties give more information about the cause of the exception: FirstDimensionType, FirstParameterName, SecondDimensionType and SecondParameterName.

You can avoid this exception by verifying that the dimensions of the objects (RowCount, ColumnCount and/or Length) are compatible for the operation you want to perform.

Constructors

DimensionMismatchException() Constructs a new DimensionMismatchException.
DimensionMismatchException(String) Constructs a new DimensionMismatchException.
DimensionMismatchException(SerializationInfo, StreamingContext) Initializes a new instance of the MatrixNotPositiveDefiniteException class with serialized data.
Obsolete.
DimensionMismatchException(String, Exception) Constructs a new DimensionMismatchException.
DimensionMismatchException(DimensionType, String, DimensionType) Constructs a new DimensionMismatchException.
DimensionMismatchException(DimensionType, String, String) Constructs a new DimensionMismatchException.
DimensionMismatchException(DimensionType, String, DimensionType, String) Constructs a new DimensionMismatchException.
DimensionMismatchException(String, Exception, DimensionType, String, DimensionType, String) Constructs a new DimensionMismatchException.

Properties

DataGets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception)
FirstDimensionType Gets which dimension of the first object was mismatched.
FirstParameterName Gets the name of the first parameter whose dimensions were mismatched.
HelpLinkGets or sets a link to the help file associated with this exception.
(Inherited from Exception)
HResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception)
InnerExceptionGets the Exception instance that caused the current exception.
(Inherited from Exception)
MessageGets the error message and the parameter name, or only the error message if no parameter name is set.
(Inherited from ArgumentException)
ParamNameGets the name of the parameter that causes this exception.
(Inherited from ArgumentException)
SecondDimensionType Gets which dimension of the second object was mismatched.
SecondParameterName Gets the name of the second parameter whose dimensions were mismatched.
SourceGets or sets the name of the application or the object that causes the error.
(Inherited from Exception)
StackTraceGets a string representation of the immediate frames on the call stack.
(Inherited from Exception)
TargetSiteGets the method that throws the current exception.
(Inherited from Exception)

Methods

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)
GetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetObjectData Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ArgumentException.GetObjectData(SerializationInfo, StreamingContext))
Obsolete.
GetTypeGets the runtime type of the current instance.
(Inherited from Exception)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringCreates and returns a string representation of the current exception.
(Inherited from Exception)

Events

SerializeObjectStateOccurs when an exception is serialized to create an exception state object that contains serialized data about the exception.
(Inherited from Exception)
Obsolete.

See Also