blas-0.6: Bindings to the BLAS library Source code Contents Index

BLAS.Tensor.Immutable Stability experimental Maintainer Patrick Perry <patperry@stanford.edu>

Description

Synopsis

class BaseTensor x i => ITensor x i where size :: x n e -> Int (//) :: BLAS1 e => x n e -> [(i, e)] -> x n e unsafeAt :: Elem e => x n e -> i -> e unsafeReplace :: BLAS1 e => x n e -> [(i, e)] -> x n e indices :: x n e -> [i] elems :: Elem e => x n e -> [e] assocs :: Elem e => x n e -> [(i, e)] tmap :: BLAS1 e => (e -> e) -> x n e -> x n e (*>) :: BLAS1 e => e -> x n e -> x n e shift :: BLAS1 e => e -> x n e -> x n e (!) :: (ITensor x i, Elem e) => x n e -> i -> e

Documentation

class BaseTensor x i => ITensor x i where Source

A class for immutable tensors. Methods size :: x n e -> Int Source Get the numer of elements stored in the tensor. (//) :: BLAS1 e => x n e -> [(i, e)] -> x n e Source Get a new tensor by replacing the elements at the given indices. unsafeAt :: Elem e => x n e -> i -> e Source Get the value at the given index, without doing any bounds-checking. unsafeReplace :: BLAS1 e => x n e -> [(i, e)] -> x n e Source Same as '()' but doesn't do any bounds-checking. indices :: x n e -> [i] Source Get the indices of the elements stored in the tensor. elems :: Elem e => x n e -> [e] Source Get the elements stored in the tensor. assocs :: Elem e => x n e -> [(i, e)] Source Get the list of (index, element) pairs stored in the tensor. tmap :: BLAS1 e => (e -> e) -> x n e -> x n e Source Apply a function elementwise to a tensor. (*>) :: BLAS1 e => e -> x n e -> x n e Source Scale every element by the given value. shift :: BLAS1 e => e -> x n e -> x n e Source Add a constant to every element. Instances ITensor Vector Int ITensor Vector Int ITensor Matrix ((,) Int Int) ITensor Matrix ((,) Int Int) ITensor Banded ((,) Int Int) ITensor Banded ((,) Int Int)

(!) :: (ITensor x i, Elem e) => x n e -> i -> e Source

Get the value at the given index. Range-checks the argument.

Produced by Haddock version 2.3.0