Show / Hide Table of Contents

Class NDArray<T>

A powerful N-dimensional array object Inspired from https://www.numpy.org/devdocs/user/quickstart.html

Inheritance
System.Object
NDArray<T>
Matrix<TData>
Implements
System.Collections.IEnumerable
System.Collections.IEnumerator
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NumSharp
Assembly: NumSharp.dll
Syntax
public class NDArray<T> : IEnumerable, IEnumerator
Type Parameters
Name Description
T

dtype

Constructors

| Improve this Doc View Source

NDArray()

Declaration
public NDArray()

Properties

| Improve this Doc View Source

Current

Declaration
public object Current { get; }
Property Value
Type Description
System.Object
| Improve this Doc View Source

Data

1 dim array data storage

Declaration
public T[] Data { get; set; }
Property Value
Type Description
T[]
| Improve this Doc View Source

Item[NDArray<Int32>]

Overload

Declaration
public NDArray<T> this[NDArray<int> select] { get; }
Parameters
Type Name Description
NDArray<System.Int32> select
Property Value
Type Description
NDArray<T>
| Improve this Doc View Source

Item[Shape]

Declaration
public NDArray<T> this[Shape select] { get; }
Parameters
Type Name Description
Shape select
Property Value
Type Description
NDArray<T>
| Improve this Doc View Source

Item[Slice]

Declaration
public NDArray<NDArray<T>> this[Slice select] { get; }
Parameters
Type Name Description
Slice select
Property Value
Type Description
NDArray<NDArray<T>>
| Improve this Doc View Source

Item[IList<Int32>]

Filter specific elements through select.

Declaration
public NDArray<T> this[IList<int> select] { get; }
Parameters
Type Name Description
System.Collections.Generic.IList<System.Int32> select
Property Value
Type Description
NDArray<T>

Return a new NDArray with filterd elements.

| Improve this Doc View Source

Item[Int32[]]

Index accessor

Declaration
public T this[params int[] select] { get; set; }
Parameters
Type Name Description
System.Int32[] select
Property Value
Type Description
T
| Improve this Doc View Source

NDim

Dimension count

Declaration
public int NDim { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Shape

Data length of every dimension

Declaration
public Shape Shape { get; set; }
Property Value
Type Description
Shape
| Improve this Doc View Source

Size

Total of elements

Declaration
public int Size { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

_ParseNumber(T, ref Int32, ref Int32)

Declaration
protected string _ParseNumber(T number, ref int noBefore, ref int noAfter)
Parameters
Type Name Description
T number
System.Int32 noBefore
System.Int32 noAfter
Returns
Type Description
System.String
| Improve this Doc View Source

_ToMatrixString()

Declaration
protected string _ToMatrixString()
Returns
Type Description
System.String
| Improve this Doc View Source

_ToVectorString()

Declaration
protected string _ToVectorString()
Returns
Type Description
System.String
| Improve this Doc View Source

arange(Int32, Int32, Int32)

Declaration
public NDArray<T> arange(int stop, int start = 0, int step = 1)
Parameters
Type Name Description
System.Int32 stop
System.Int32 start
System.Int32 step
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

dot(NDArray<T>)

Declaration
public NDArray<T> dot(NDArray<T> np2)
Parameters
Type Name Description
NDArray<T> np2
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

GetEnumerator()

Declaration
public IEnumerator GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

inv()

Declaration
public NDArray<T> inv()
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

linspace(Double, Double, Int32, Boolean)

Declaration
public NDArray<T> linspace(double start, double stop, int num, bool entdpoint = true)
Parameters
Type Name Description
System.Double start
System.Double stop
System.Int32 num
System.Boolean entdpoint
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

log()

Declaration
public NDArray<T> log()
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

MoveNext()

Declaration
public bool MoveNext()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

multi_dot(NDArray<T>[])

Declaration
public NDArray<T> multi_dot(params NDArray<T>[] np2Multi)
Parameters
Type Name Description
NDArray<T>[] np2Multi
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

power(T)

Declaration
public NDArray<T> power(T exponent)
Parameters
Type Name Description
T exponent
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Reset()

Declaration
public void Reset()
| Improve this Doc View Source

reshape(Int32[])

Gives a new shape to an array without changing its data.

Declaration
public NDArray<T> reshape(params int[] shape)
Parameters
Type Name Description
System.Int32[] shape
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Set(Shape, T)

Declaration
public void Set(Shape shape, T value)
Parameters
Type Name Description
Shape shape
T value
| Improve this Doc View Source

ToDotNetArray<TCast>()

Declaration
public TCast ToDotNetArray<TCast>()
Returns
Type Description
TCast
Type Parameters
Name Description
TCast
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()
| Improve this Doc View Source

transpose()

Declaration
public NDArray<T> transpose()
Returns
Type Description
NDArray<T>

Operators

| Improve this Doc View Source

Addition(NDArray<T>, T)

Declaration
public static NDArray<T> operator +(NDArray<T> np1, T scalar)
Parameters
Type Name Description
NDArray<T> np1
T scalar
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Addition(NDArray<T>, NDArray<T>)

Declaration
public static NDArray<T> operator +(NDArray<T> np1, NDArray<T> np2)
Parameters
Type Name Description
NDArray<T> np1
NDArray<T> np2
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Division(NDArray<T>, T)

Declaration
public static NDArray<T> operator /(NDArray<T> np1, T scalar)
Parameters
Type Name Description
NDArray<T> np1
T scalar
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Division(NDArray<T>, NDArray<T>)

Declaration
public static NDArray<T> operator /(NDArray<T> np1, NDArray<T> np2)
Parameters
Type Name Description
NDArray<T> np1
NDArray<T> np2
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Equality(NDArray<T>, Object)

Declaration
public static bool operator ==(NDArray<T> np, object obj)
Parameters
Type Name Description
NDArray<T> np
System.Object obj
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Inequality(NDArray<T>, Object)

Declaration
public static bool operator !=(NDArray<T> np, object obj)
Parameters
Type Name Description
NDArray<T> np
System.Object obj
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Multiply(T, NDArray<T>)

Declaration
public static NDArray<T> operator *(T scalar, NDArray<T> np1)
Parameters
Type Name Description
T scalar
NDArray<T> np1
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Multiply(NDArray<T>, T)

Declaration
public static NDArray<T> operator *(NDArray<T> np1, T scalar)
Parameters
Type Name Description
NDArray<T> np1
T scalar
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Multiply(NDArray<T>, NDArray<T>)

Declaration
public static NDArray<T> operator *(NDArray<T> np1, NDArray<T> np2)
Parameters
Type Name Description
NDArray<T> np1
NDArray<T> np2
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Subtraction(NDArray<T>, T)

Declaration
public static NDArray<T> operator -(NDArray<T> np1, T scalar)
Parameters
Type Name Description
NDArray<T> np1
T scalar
Returns
Type Description
NDArray<T>
| Improve this Doc View Source

Subtraction(NDArray<T>, NDArray<T>)

Declaration
public static NDArray<T> operator -(NDArray<T> np1, NDArray<T> np2)
Parameters
Type Name Description
NDArray<T> np1
NDArray<T> np2
Returns
Type Description
NDArray<T>

Implements

System.Collections.IEnumerable
System.Collections.IEnumerator

Extension Methods

NDArrayExtensions.HStack<T>(NDArray<T>, NDArray<T>[])
NDArrayExtensions.Sum<TData>(NDArray<TData>, NDArray<TData>)
NDArrayExtensions.Unique<T>(NDArray<T>)
NDArrayExtensions.VStack<T>(NDArray<T>, NDArray<T>[])
  • Improve this Doc
  • View Source
Back to top Generated by DocFX