darray

class minkit.darray(array, ndim=1, length=None, backend=None)[source]

Bases: minkit.farray

Array of floats.

Parameters
Tye backend

Backend

Attributes Summary

aop

Associated object to do array operations.

backend

Backend interface.

dtype

Data type.

length

Length as a numpy.int32 instance.

ndim

Number of dimensions of the array.

shape

Shape of the array.

size

Size of the array.

ua

Underlying array.

Methods Summary

as_ndarray()

Return the underlying array as a numpy.ndarray instance.

astype(dtype)

Convert the array into the given data type.

copy()

Copy this array.

from_ndarray(a, backend)

Create this class from a numpy.ndarray instance.

get(i)

Get an element of the array.

max()

Minimum value of the elements in the array.

min()

Minimum value of the elements in the array.

slice(a)

Get a slice of this array, that can be done using a boolean mask or an array of integers.

sum()

Sum the elements in the array.

take_column([i])

Take elements of the array using a period.

take_slice([start, end])

Take a slice of entries from the array.

to_backend(backend)

Send the array to the given backend.

Attributes Documentation

aop

Associated object to do array operations.

backend

Backend interface.

dtype

Data type.

length

Length as a numpy.int32 instance.

ndim

Number of dimensions of the array.

shape

Shape of the array.

size

Size of the array.

ua

Underlying array.

Methods Documentation

as_ndarray()

Return the underlying array as a numpy.ndarray instance. If the underlying array is already of this type, no copy is done.

Returns

underlying array as a numpy.ndarray.

Return type

numpy.ndarray

astype(dtype)

Convert the array into the given data type. Only conversions from farray and carray objects are allowed.

Parameters

dtype (numpy.dtype) – data type.

Returns

Converted array.

Return type

farray or carray

Raises

ValueError – If the conversion is not allowed.

copy()

Copy this array.

Returns

Copy of this array.

classmethod from_ndarray(a, backend)[source]

Create this class from a numpy.ndarray instance. If the number of dimensions is greater than one, the array is flattened, and each column is assumed to belong to a different parameter.

Parameters
Returns

Newly created array.

get(i)

Get an element of the array. The output type depends on the type of array.

Parameters

i (int) – index.

Returns

value at the given index.

Return type

float, int or bool

max()[source]

Minimum value of the elements in the array.

Returns

maximum of the elements.

Return type

float

min()[source]

Minimum value of the elements in the array.

Returns

minimum of the elements.

Return type

float

slice(a)[source]

Get a slice of this array, that can be done using a boolean mask or an array of integers.

Parameters

a (barray or iarray) – mask or indices array.

Returns

slice of this array.

Return type

darray

sum()[source]

Sum the elements in the array.

Returns

sum of elements.

Return type

float

take_column(i=0)[source]

Take elements of the array using a period.

Parameters

i (int) – column to take the elements.

Returns

reduced array.

Return type

marray

take_slice(start=0, end=None)[source]

Take a slice of entries from the array.

Parameters
  • start (int) – where to start taking entries.

  • end (int) – where to end taking entries.

Returns

slice of the array.

Return type

marray

to_backend(backend)

Send the array to the given backend.

Parameters

backend (Backend) – backend where to transfer the array.

Returns

this array on a new backend.

Return type

marray