| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Numerical.HBLAS.MatrixTypes
Description
PSA, the matrix data types used in the hBLAS binding should not be regarded as being general purpose matrices.
They are designed to exactly express only the matrices which are valid inputs for BLAS. When applicable, such matrices should be easily mapped to and from other matrix libraries. That said, the BLAS and LAPACK matrix formats capture a rich and very expressive subset of Dense Matrix formats.
The primary and hence default format is Dense Row and Column Major Matrices, but support will be added for other formats that BLAS and LAPACK provide operations for.
A guiding rule of thumb for this package is that there are no generic abstractions provided, merely machinery to ensure all uses of BLAS and LAPACK operations can be used in their full generality in a human friendly type safe fashion. It is the role of a higher level library to provide any generic operations.
One such higher level lib you can interface with easily is Numerical. There is a work in progress binding to help this in the numerical-hblas package (which may not be public yet at the time of this writing)
- data Orientation
- type Row = Row
- type Column = Column
- data SOrientation :: Orientation -> * where
- sTranpose :: (x ~ TransposeF y, y ~ TransposeF x) => SOrientation x -> SOrientation y
- data Transpose
- data MatUpLo
- data MatDiag
- data EquationSide
- type family TransposeF x :: Orientation
- data Variant
- data SVariant :: Variant -> * where
- SImplicit :: {
- _frontPadding :: !Int
- _endPadding :: !Int
- SDirect :: SVariant Direct
- SImplicit :: {
- data DenseVector :: Variant -> * -> * where
- DenseVector :: {
- _VariantDenseVect :: !(SVariant varnt)
- _LogicalDimDenseVector :: !Int
- _StrideDenseVector :: !Int
- _bufferDenseVector :: !(Vector elem)
- DenseVector :: {
- data MDenseVector :: * -> Variant -> * -> * where
- MutableDenseVector :: {
- _VariantMutDenseVect :: !(SVariant varnt)
- _LogicalDimMutDenseVector :: !Int
- _StrideMutDenseVector :: !Int
- _bufferMutDenseVector :: !(MVector s elem)
- MutableDenseVector :: {
- data DenseMatrix :: Orientation -> * -> * where
- DenseMatrix :: {
- _OrientationMat :: SOrientation ornt
- _XdimDenMat :: !Int
- _YdimDenMat :: !Int
- _StrideDenMat :: !Int
- _bufferDenMat :: !(Vector elem)
- DenseMatrix :: {
- mutableVectorToList :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> m [a]
- data MDenseMatrix :: * -> Orientation -> * -> * where
- MutableDenseMatrix :: {
- _OrientationMutMat :: SOrientation ornt
- _XdimDenMutMat :: !Int
- _YdimDenMutMat :: !Int
- _StrideDenMutMat :: !Int
- _bufferDenMutMat :: !(MVector s elem)
- MutableDenseMatrix :: {
- type IODenseMatrix = MDenseMatrix RealWorld
- unsafeFreezeDenseMatrix :: (Storable elem, PrimMonad m) => MDenseMatrix (PrimState m) or elem -> m (DenseMatrix or elem)
- unsafeThawDenseMatrix :: (Storable elem, PrimMonad m) => DenseMatrix or elem -> m (MDenseMatrix (PrimState m) or elem)
- getDenseMatrixRow :: DenseMatrix or elem -> Int
- getDenseMatrixColumn :: DenseMatrix or elem -> Int
- getDenseMatrixLeadingDimStride :: DenseMatrix or elem -> Int
- getDenseMatrixArray :: DenseMatrix or elem -> Vector elem
- getDenseMatrixOrientation :: DenseMatrix or elem -> SOrientation or
- uncheckedDenseMatrixIndex :: Storable elem => DenseMatrix or elem -> (Int, Int) -> elem
- uncheckedDenseMatrixIndexM :: (Monad m, Storable elem) => DenseMatrix or elem -> (Int, Int) -> m elem
- uncheckedMutableDenseMatrixIndexM :: (PrimMonad m, Storable elem) => MDenseMatrix (PrimState m) or elem -> (Int, Int) -> m elem
- swap :: (a, b) -> (b, a)
- mapDenseMatrix :: (Storable a, Storable b) => (a -> b) -> DenseMatrix or a -> DenseMatrix or b
- imapDenseMatrix :: (Storable a, Storable b) => ((Int, Int) -> a -> b) -> DenseMatrix or a -> DenseMatrix or b
- uncheckedDenseMatrixNextTuple :: DenseMatrix or elem -> (Int, Int) -> Maybe (Int, Int)
- generateDenseMatrix :: Storable a => SOrientation x -> (Int, Int) -> ((Int, Int) -> a) -> DenseMatrix x a
- generateMutableDenseMatrix :: (Storable a, PrimMonad m) => SOrientation x -> (Int, Int) -> ((Int, Int) -> a) -> m (MDenseMatrix (PrimState m) x a)
- generateMutableDenseVector :: (Storable a, PrimMonad m) => Int -> (Int -> a) -> m (MDenseVector (PrimState m) Direct a)
- uncheckedDenseMatrixSlice :: Storable elem => DenseMatrix or elem -> (Int, Int) -> (Int, Int) -> DenseMatrix or elem
- transposeDenseMatrix :: (inor ~ TransposeF outor, outor ~ TransposeF inor) => DenseMatrix inor elem -> DenseMatrix outor elem
Documentation
data Orientation Source
Instances
data SOrientation :: Orientation -> * where Source
Constructors
| SRow :: SOrientation Row | |
| SColumn :: SOrientation Column |
Instances
sTranpose :: (x ~ TransposeF y, y ~ TransposeF x) => SOrientation x -> SOrientation y Source
Constructors
| NoTranspose | |
| Transpose | |
| ConjTranspose | |
| ConjNoTranspose |
For Symmetric, Hermetian or Triangular matrices, which part is modeled.
Many triangular matrix routines expect to know if the matrix is all 1 (unit ) on the diagonal or not. Likewise, Many Factorizations routines can be assumed to return unit triangular matrices
Constructors
| MatUnit | |
| MatNonUnit |
data EquationSide Source
For certain Square matrix product, do you want to Compute A*B or B*A only used as an argument
Instances
type family TransposeF x :: Orientation Source
Instances
| type TransposeF Column = Row | |
| type TransposeF Row = Column |
data SVariant :: Variant -> * where Source
Variant and SVariant are a bit odd looking,
They crop up when needing to talk about eg the row vectors of a
packed triangular row major matrix wrt both their logical size and manifest sizes
this notion only makes sense in the 1dim case.
If you don't understand this parameter, just use SDirect and Direct
as they will generally be the correct choice for most users.
data DenseVector :: Variant -> * -> * where Source
Constructors
| DenseVector :: !(SVariant varnt) -> !Int -> !Int -> !(Vector elem) -> DenseVector varnt elem | |
Fields
| |
data MDenseVector :: * -> Variant -> * -> * where Source
Constructors
| MutableDenseVector :: !(SVariant varnt) -> !Int -> !Int -> !(MVector s elem) -> MDenseVector s varnt elem | |
Fields
| |
data DenseMatrix :: Orientation -> * -> * where Source
DenseMatrix is for dense row or column major matrices
Constructors
| DenseMatrix :: SOrientation ornt -> !Int -> !Int -> !Int -> !(Vector elem) -> DenseMatrix ornt elem | |
Fields
| |
Instances
| (Show el, Storable el) => Show (DenseMatrix Column el) | |
| (Show el, Storable el) => Show (DenseMatrix Row el) |
mutableVectorToList :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> m [a] Source
this should never be used in real code, ever ever, but its handy for testing but seriously never use this in real code, it doesn't do what you think because in the case of a matrix slice, the underlying buffer will have additional elements aside from the ones you expect! never use this in real code please. :)
data MDenseMatrix :: * -> Orientation -> * -> * where Source
Constructors
| MutableDenseMatrix :: SOrientation ornt -> !Int -> !Int -> !Int -> !(MVector s elem) -> MDenseMatrix s ornt elem | |
Fields
| |
type IODenseMatrix = MDenseMatrix RealWorld Source
unsafeFreezeDenseMatrix :: (Storable elem, PrimMonad m) => MDenseMatrix (PrimState m) or elem -> m (DenseMatrix or elem) Source
unsafeThawDenseMatrix :: (Storable elem, PrimMonad m) => DenseMatrix or elem -> m (MDenseMatrix (PrimState m) or elem) Source
getDenseMatrixRow :: DenseMatrix or elem -> Int Source
getDenseMatrixColumn :: DenseMatrix or elem -> Int Source
getDenseMatrixLeadingDimStride :: DenseMatrix or elem -> Int Source
getDenseMatrixArray :: DenseMatrix or elem -> Vector elem Source
getDenseMatrixOrientation :: DenseMatrix or elem -> SOrientation or Source
uncheckedDenseMatrixIndex :: Storable elem => DenseMatrix or elem -> (Int, Int) -> elem Source
uncheckedDenseMatrixIndexM :: (Monad m, Storable elem) => DenseMatrix or elem -> (Int, Int) -> m elem Source
uncheckedMutableDenseMatrixIndexM :: (PrimMonad m, Storable elem) => MDenseMatrix (PrimState m) or elem -> (Int, Int) -> m elem Source
mapDenseMatrix :: (Storable a, Storable b) => (a -> b) -> DenseMatrix or a -> DenseMatrix or b Source
`map f matrix`
imapDenseMatrix :: (Storable a, Storable b) => ((Int, Int) -> a -> b) -> DenseMatrix or a -> DenseMatrix or b Source
uncheckedDenseMatrixNextTuple :: DenseMatrix or elem -> (Int, Int) -> Maybe (Int, Int) Source
In Matrix format memory order enumeration of the index tuples, for good locality 2dim map
generateDenseMatrix :: Storable a => SOrientation x -> (Int, Int) -> ((Int, Int) -> a) -> DenseMatrix x a Source
generateDenseMatrix Row (k,k) (i,j)-> if i == j then 1.0 else 0.0 would generate a KxK identity matrix
generateMutableDenseMatrix :: (Storable a, PrimMonad m) => SOrientation x -> (Int, Int) -> ((Int, Int) -> a) -> m (MDenseMatrix (PrimState m) x a) Source
mutable version of generateDenseMatrix
generateMutableDenseVector :: (Storable a, PrimMonad m) => Int -> (Int -> a) -> m (MDenseVector (PrimState m) Direct a) Source
uncheckedDenseMatrixSlice :: Storable elem => DenseMatrix or elem -> (Int, Int) -> (Int, Int) -> DenseMatrix or elem Source
transposeDenseMatrix :: (inor ~ TransposeF outor, outor ~ TransposeF inor) => DenseMatrix inor elem -> DenseMatrix outor elem Source
tranposeMatrix does a shallow transpose that swaps the format and the x y params, but changes nothing in the memory layout. Most applications where transpose is used in a computation need a deep, copying, tranpose operation