Table of Contents

Class NPTypeCodeExtensions

Namespace
NumSharp
Assembly
NumSharp.dll
public static class NPTypeCodeExtensions
Inheritance
NPTypeCodeExtensions
Inherited Members

Methods

AsType(NPTypeCode)

Convert NPTypeCode into its Type

public static Type AsType(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

Type

CompareTo(NPTypeCode, NPTypeCode) 

public static int CompareTo(this NPTypeCode left, NPTypeCode right)

Parameters

left NPTypeCode
right NPTypeCode

Returns

int

GetAccumulatingType(NPTypeCode)

Gets the dtype that is used as accumulation in case when statistics are computed like sum(NDArray)

public static NPTypeCode GetAccumulatingType(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

NPTypeCode

dtype in case when statistics are computed like sum(NDArray)

GetComputingType(NPTypeCode)

Gets the dtype that is used as return type in case when statistics are computed with high decimal precision like sin(NDArray, NPTypeCode?)

public static NPTypeCode GetComputingType(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

NPTypeCode

dtype in case when statistics are computed like mean(NDArray)

GetDefaultValue(NPTypeCode)

Gets the default value of typeCode.

public static object GetDefaultValue(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

object

GetOneValue(NPTypeCode)

Gets the multiplicative identity (1) for a type. Used for reduction identity in Product operations.

public static object GetOneValue(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

object

GetTypeCode(Type)

Extracts NPTypeCode from given Type.

public static NPTypeCode GetTypeCode(this Type type)

Parameters

type Type

Returns

NPTypeCode

Remarks

In case there was no successful cast to NPTypeCode, return will be Empty

GetTypeCode<T>()

Extracts NPTypeCode from given T.

public static NPTypeCode GetTypeCode<T>()

Returns

NPTypeCode

Type Parameters

T

Remarks

In case there was no successful cast to NPTypeCode, return will be Empty

IsFloatingPoint(NPTypeCode)

Is typeCode a floating point type (float, double, or decimal)?

public static bool IsFloatingPoint(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

bool

IsInteger(NPTypeCode)

Is typeCode an integer type (signed or unsigned)?

public static bool IsInteger(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

bool

Remarks

Excludes Boolean and Char.

IsNumerical(NPTypeCode)

Returns true if typecode is a number (incl. bool, char, Half and Complex).

public static bool IsNumerical(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

bool

IsRealNumber(NPTypeCode)

Is typeCode a float, double, complex or decimal?

public static bool IsRealNumber(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

bool

IsSigned(NPTypeCode)

Is typeCode a float, double, complex or decimal?

public static bool IsSigned(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

bool

IsSimdCapable(NPTypeCode)

Is typeCode capable of SIMD operations?

public static bool IsSimdCapable(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

bool

Remarks

Returns true if the type can use SIMD when hardware support is available. Does not check if SIMD hardware is actually available. Boolean, Char, and Decimal cannot use SIMD.

IsUnsigned(NPTypeCode)

Is typeCode a uint, byte, ulong and so on.

public static bool IsUnsigned(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

bool

IsValidNPType(Type)

Checks if given Type has a match in NPTypeCode.

public static bool IsValidNPType(this Type type)

Parameters

type Type

Returns

bool

SizeOf(NPTypeCode)

Gets the size of given typeCode

public static int SizeOf(this NPTypeCode typeCode)

Parameters

typeCode NPTypeCode

Returns

int

Remarks

The size is computed by SizeOf<T>()

Edit this page