Multilinear.Index

Generic tensor index which may be finitely- or infinitely-dimensional.

Documentation

class Index i where

Tensor index class which may be lower (covariant), upper (contravariant) or indifferent.

Minimal complete definition

indexName, isCovariant, isContravariant, equivI, toTIndex

Methods

indexName :: i -> String

Index name

isCovariant :: i -> Bool

Returns True if index is lower (covariant), False otherwise.

isContravariant :: i -> Bool

Returns True if index is upper (contravariant), False otherwise.

equivI :: i -> i -> Bool

Returns True if two indices are equivalent, thus differs only by name, but share same size and type.

(!=!) :: i -> i -> Bool infixl 2

Infix equivalent for equiv. Has low priority equal to 2.

toTIndex :: i -> TIndex

Convert to generic index type

Instances

Index TIndex

Finite index is a Multilinear.Index instance

Defined in Multilinear.Index

Methods

indexName :: TIndex -> String

isCovariant :: TIndex -> Bool

isContravariant :: TIndex -> Bool

equivI :: TIndex -> TIndex -> Bool

(!=!) :: TIndex -> TIndex -> Bool

toTIndex :: TIndex -> TIndex

Index Index

Finite index is a Multilinear.Index instance

Defined in Multilinear.Index.Finite

Methods

indexName :: Index -> String

isCovariant :: Index -> Bool

isContravariant :: Index -> Bool

equivI :: Index -> Index -> Bool

(!=!) :: Index -> Index -> Bool

toTIndex :: Index -> TIndex

data TIndex

Generic index type finitely- or infinitely-dimensional

Constructors

Covariant

Fields

• indexSize :: Maybe Int
• tIndexName :: String

Contravariant

Fields

• indexSize :: Maybe Int
• tIndexName :: String

Instances

Eq TIndex

Defined in Multilinear.Index

Methods

(==) :: TIndex -> TIndex -> Bool

(/=) :: TIndex -> TIndex -> Bool

Ord TIndex

Indices can be compared by its name and size |

Used to allow to put tensors to typical ordered containers |

Defined in Multilinear.Index

Methods

compare :: TIndex -> TIndex -> Ordering

(<) :: TIndex -> TIndex -> Bool

(<=) :: TIndex -> TIndex -> Bool

(>) :: TIndex -> TIndex -> Bool

(>=) :: TIndex -> TIndex -> Bool

max :: TIndex -> TIndex -> TIndex

min :: TIndex -> TIndex -> TIndex

Show TIndex

Show tensor index

Defined in Multilinear.Index

Methods

showsPrec :: Int -> TIndex -> ShowS

show :: TIndex -> String

showList :: [TIndex] -> ShowS

Generic TIndex

Defined in Multilinear.Index

Associated Types

type Rep TIndex :: Type -> Type

Methods

from :: TIndex -> Rep TIndex x

to :: Rep TIndex x -> TIndex

Index TIndex

Finite index is a Multilinear.Index instance

Defined in Multilinear.Index

Methods

indexName :: TIndex -> String

isCovariant :: TIndex -> Bool

isContravariant :: TIndex -> Bool

equivI :: TIndex -> TIndex -> Bool

(!=!) :: TIndex -> TIndex -> Bool

toTIndex :: TIndex -> TIndex

type Rep TIndex

Defined in Multilinear.Index

type Rep TIndex = D1 (MetaData "TIndex" "Multilinear.Index" "multilinear-0.5.0.0-JAkyVGJu3RMGLoRm7N5fIc" False) (C1 (MetaCons "Covariant" PrefixI True) (S1 (MetaSel (Just "indexSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "tIndexName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "Contravariant" PrefixI True) (S1 (MetaSel (Just "indexSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "tIndexName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))