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

Data.Matrix.Banded Stability experimental Maintainer Patrick Perry <patperry@stanford.edu>

Contents Banded matrix type Banded shape Creating banded matrices Reading banded matrix elements Special banded matrices Vector views Converting to lists Low-level properties Matrix and vector multiplication Converting between mutable and immutable banded matrices

Description

Synopsis

newtype Banded mn e = B (IOBanded mn e) module BLAS.Tensor.Base module BLAS.Matrix.Base bandwidth :: BaseBanded a x => a mn e -> (Int, Int) numLower :: BaseBanded a x => a mn e -> Int numUpper :: BaseBanded a x => a mn e -> Int coerceBanded :: BaseBanded a x => a mn e -> a mn' e banded :: BLAS1 e => (Int, Int) -> (Int, Int) -> [((Int, Int), e)] -> Banded (m, n) e listsBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> [[e]] -> Banded (m, n) e unsafeBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> [((Int, Int), e)] -> Banded (m, n) e module BLAS.Tensor.Immutable zeroBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> Banded (m, n) e constantBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> e -> Banded (m, n) e diagBanded :: BLAS1 e => Banded mn e -> Int -> Vector k e unsafeDiagBanded :: BLAS1 e => Banded mn e -> Int -> Vector k e listsFromBanded :: BLAS1 e => Banded mn e -> ((Int, Int), (Int, Int), [[e]]) ldaOfBanded :: BaseBanded a x => a mn e -> Int isHermBanded :: BaseBanded a x => a mn e -> Bool module BLAS.Matrix.Immutable class UnsafeFreezeBanded a where unsafeFreezeBanded :: a mn e -> Banded mn e class UnsafeThawBanded a where unsafeThawBanded :: Banded mn e -> a mn e freezeBanded :: (ReadBanded a x m, WriteBanded b y m, UnsafeFreezeBanded b, BLAS1 e) => a mn e -> m (Banded mn e) thawBanded :: (WriteBanded a y m, BLAS1 e) => Banded mn e -> m (a mn e)

Banded matrix type

newtype Banded mn e Source

Constructors B (IOBanded mn e) Instances BaseMatrix Banded BaseBanded Banded Vector BLAS2 e => IMatrix Banded e (BLAS2 e, UnsafeIOToM m) => MMatrix Banded e m UnsafeIOToM m => ReadBanded Banded Vector m BaseTensor Banded ((,) Int Int) ITensor Banded ((,) Int Int) Monad m => ReadTensor Banded ((,) Int Int) m (BLAS1 e, Eq e) => Eq (Banded mn e) BLAS1 e => Show (Banded mn e) (BLAS1 e, AEq e) => AEq (Banded mn e)

Banded shape

module BLAS.Tensor.Base

module BLAS.Matrix.Base

bandwidth :: BaseBanded a x => a mn e -> (Int, Int) Source

numLower :: BaseBanded a x => a mn e -> Int Source

numUpper :: BaseBanded a x => a mn e -> Int Source

coerceBanded :: BaseBanded a x => a mn e -> a mn' e Source

Cast the shape type of the matrix.

Creating banded matrices

banded :: BLAS1 e => (Int, Int) -> (Int, Int) -> [((Int, Int), e)] -> Banded (m, n) e Source

listsBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> [[e]] -> Banded (m, n) e Source

unsafeBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> [((Int, Int), e)] -> Banded (m, n) e Source

Reading banded matrix elements

module BLAS.Tensor.Immutable

Special banded matrices

zeroBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> Banded (m, n) e Source

constantBanded :: BLAS1 e => (Int, Int) -> (Int, Int) -> e -> Banded (m, n) e Source

Vector views

diagBanded :: BLAS1 e => Banded mn e -> Int -> Vector k e Source

Get a the given diagonal in a banded matrix. Negative indices correspond to sub-diagonals.

unsafeDiagBanded :: BLAS1 e => Banded mn e -> Int -> Vector k e Source

Same as diagBanded but index is not range-checked.

Converting to lists

listsFromBanded :: BLAS1 e => Banded mn e -> ((Int, Int), (Int, Int), [[e]]) Source

Low-level properties

ldaOfBanded :: BaseBanded a x => a mn e -> Int Source

isHermBanded :: BaseBanded a x => a mn e -> Bool Source

Matrix and vector multiplication

module BLAS.Matrix.Immutable

Converting between mutable and immutable banded matrices

class UnsafeFreezeBanded a where Source

Methods unsafeFreezeBanded :: a mn e -> Banded mn e Source Instances UnsafeFreezeBanded IOBanded UnsafeFreezeBanded (STBanded s)

class UnsafeThawBanded a where Source

Methods unsafeThawBanded :: Banded mn e -> a mn e Source Instances UnsafeThawBanded IOBanded UnsafeThawBanded (STBanded s)

freezeBanded :: (ReadBanded a x m, WriteBanded b y m, UnsafeFreezeBanded b, BLAS1 e) => a mn e -> m (Banded mn e) Source

thawBanded :: (WriteBanded a y m, BLAS1 e) => Banded mn e -> m (a mn e) Source

Produced by Haddock version 2.3.0