Class NumSharpException

Namespace

NumSharp

Assembly

NumSharp.dll

public class NumSharpException : Exception, ISerializable, INumSharpException

Inheritance

object

Exception

NumSharpException

Implements

ISerializable

INumSharpException

Derived

IncorrectShapeException

IncorrectSizeException

IncorrectTypeException

Inherited Members

Exception.GetBaseException()

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LinqExtensions.Yield<T>(T)

Constructors

NumSharpException()

Initializes a new instance of the Exception class.

public NumSharpException()

NumSharpException(string)

Initializes a new instance of the Exception class with a specified error message.

public NumSharpException(string message)

Parameters

message string

The message that describes the error.

NumSharpException(string, Exception)

Initializes a new instance of the Exception class with a specified error message and a reference to the inner exception that is the cause of this exception.

public NumSharpException(string message, Exception innerException)

Parameters

message string

The error message that explains the reason for the exception.

innerException Exception

The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.

Methods

ThrowIfNotWriteable(in Shape, string)

Throws if the shape is not writeable (e.g., broadcast arrays). Equivalent to NumPy's PyArray_FailUnlessWriteable.

public static void ThrowIfNotWriteable(in Shape shape, string name = "assignment destination")

Parameters

shape Shape

The shape to check.

name string

Name for the array in the error message (default: "assignment destination").

Remarks

NumPy raises: ValueError: assignment destination is read-only NumSharp raises: NumSharpException: assignment destination is read-only

Exceptions

NumSharpException

If the shape is not writeable.

ThrowReadOnly(string)

Throws the read-only exception with the standard NumPy error format.

[DoesNotReturn]
public static void ThrowReadOnly(string name = "assignment destination")

Parameters

name string

Name for the array in the error message.