Data.Tensor.Class.MTensor

Overloaded interface for mutable tensors. This modules includes tensors which can be read in a monad, ReadTensor, as well as tensors which can be modified in a monad, WriteTensor.

Read-only tensor type class

class (Shaped x i, Monad m) => ReadTensor x i e m | x -> i where

Class for mutable read-only tensors.

Methods

getSize :: x n e -> m Int

Get the number of elements stored in the tensor.

unsafeReadElem :: x n e -> i -> m e

Get the value at the specified index, without doing any range-checking.

getIndices :: x n e -> m [i]

Returns a lazy list of the indices in the tensor. Because of the laziness, this function should be used with care. See also getIndices'.

getIndices' :: x n e -> m [i]

Returns a list of the indices in the tensor. See also getIndices.

getElems :: x n e -> m [e]

Returns a lazy list of the elements in the tensor. Because of the laziness, this function should be used with care. See also getElems'.

getElems' :: x n e -> m [e]

Returns a list of the elements in the tensor. See also getElems.

getAssocs :: x n e -> m [(i, e)]

Returns a lazy list of the elements-index pairs in the tensor. Because of the laziness, this function should be used with care. See also getAssocs'.

getAssocs' :: x n e -> m [(i, e)]

Returns a list of the index-elements pairs in the tensor. See also getAssocs.

Instances

Elem e => ReadTensor IOVector Int e IO

(BLAS1 e, Monad m) => ReadTensor Vector Int e m

Elem e => ReadTensor IOMatrix (Int, Int) e IO

(BLAS3 e, Monad m) => ReadTensor Matrix (Int, Int) e m

BLAS3 e => ReadTensor IOBanded (Int, Int) e IO

(BLAS3 e, Monad m) => ReadTensor Banded (Int, Int) e m

Elem e => ReadTensor (STVector s) Int e (ST s)

Elem e => ReadTensor (STMatrix s) (Int, Int) e (ST s)

BLAS3 e => ReadTensor (STBanded s) (Int, Int) e (ST s)

readElem :: ReadTensor x i e m => x n e -> i -> m e

Gets the value at the specified index after checking that the argument is in bounds.

Modifiable tensor type class

class ReadTensor x i e m => WriteTensor x i e m | x -> m where

Class for modifiable mutable tensors.

Methods

getMaxSize :: x n e -> m Int

Get the maximum number of elements that can be stored in the tensor.

setZero :: Num e => x n e -> m ()

Sets all stored elements to zero.

setConstant :: e -> x n e -> m ()

Sets all stored elements to the given value.

canModifyElem :: x n e -> i -> m Bool

True if the value at a given index can be changed

unsafeWriteElem :: x n e -> i -> e -> m ()

Set the value of the element at the given index, without doing any range checking.

unsafeModifyElem :: x n e -> i -> (e -> e) -> m ()

Modify the value of the element at the given index, without doing any range checking.

modifyWith :: (e -> e) -> x n e -> m ()

Replace each element by a function applied to it

unsafeSwapElems :: x n e -> i -> i -> m ()

Same as swapElem but arguments are not range-checked.

doConj :: Elem e => x n e -> m ()

Replace every element with its complex conjugate.

scaleBy :: Num e => e -> x n e -> m ()

Scale every element in the vector by the given value.

shiftBy :: Num e => e -> x n e -> m ()

Add a value to every element in a vector.

Instances

BLAS1 e => WriteTensor IOVector Int e IO

BLAS1 e => WriteTensor IOMatrix (Int, Int) e IO

BLAS3 e => WriteTensor IOBanded (Int, Int) e IO

BLAS1 e => WriteTensor (STVector s) Int e (ST s)

BLAS1 e => WriteTensor (STMatrix s) (Int, Int) e (ST s)

BLAS3 e => WriteTensor (STBanded s) (Int, Int) e (ST s)

writeElem :: WriteTensor x i e m => x n e -> i -> e -> m ()

Set the value of the element at the given index.

modifyElem :: WriteTensor x i e m => x n e -> i -> (e -> e) -> m ()

Update the value of the element at the given index.

swapElems :: WriteTensor x i e m => x n e -> i -> i -> m ()

Swap the values stored at two positions in the tensor.