Clash.Sized.Internal.Index

Datatypes

newtype Index (n :: Nat)

Arbitrarily-bounded unsigned integer represented by ceil(log_2(n)) bits

Given an upper bound n, an Index n number has a range of: [0 .. n-1]

>>> maxBound :: Index 8
7
>>> minBound :: Index 8
0
>>> read (show (maxBound :: Index 8)) :: Index 8
7
>>> 1 + 2 :: Index 8
3
>>> 2 + 6 :: Index 8
*** Exception: X: Clash.Sized.Index: result 8 is out of bounds: [0..7]
...
>>> 1 - 3 :: Index 8
*** Exception: X: Clash.Sized.Index: result -2 is out of bounds: [0..7]
...
>>> 2 * 3 :: Index 8
6
>>> 2 * 4 :: Index 8
*** Exception: X: Clash.Sized.Index: result 8 is out of bounds: [0..7]
...

NB: The usual Haskell method of converting an integral numeric type to another, fromIntegral, is not well suited for Clash as it will go through Integer which is arbitrarily bounded in HDL. Instead use bitCoerce and the Resize class.

Index has the type role

>>> :i Index
type role Index nominal
...

as it is not safe to coerce between Indexes with different ranges. To change the size, use the functions in the Resize class.

Constructors

I

The constructor, I, and the field, unsafeToInteger, are not synthesizable.

Fields

• unsafeToInteger :: Integer

Instances

Resize Index

Defined in Clash.Sized.Internal.Index

Methods

resize :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Index a -> Index b

extend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Index a -> Index (b + a)

zeroExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Index a -> Index (b + a)

signExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Index a -> Index (b + a)

truncateB :: forall (a :: Nat) (b :: Nat). KnownNat a => Index (a + b) -> Index a

KnownNat n => Lift (Index n :: Type)

Defined in Clash.Sized.Internal.Index

Methods

lift :: Index n -> Q Exp

liftTyped :: Index n -> Q (TExp (Index n))

KnownNat n => Bounded (Index n)

Defined in Clash.Sized.Internal.Index

Methods

minBound :: Index n

maxBound :: Index n

KnownNat n => Enum (Index n)

The functions: enumFrom, enumFromThen, enumFromTo, and enumFromThenTo, are not synthesizable.

Defined in Clash.Sized.Internal.Index

Methods

succ :: Index n -> Index n

pred :: Index n -> Index n

toEnum :: Int -> Index n

fromEnum :: Index n -> Int

enumFrom :: Index n -> [Index n]

enumFromThen :: Index n -> Index n -> [Index n]

enumFromTo :: Index n -> Index n -> [Index n]

enumFromThenTo :: Index n -> Index n -> Index n -> [Index n]

Eq (Index n)

Defined in Clash.Sized.Internal.Index

Methods

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

(/=) :: Index n -> Index n -> Bool

KnownNat n => Integral (Index n)

NB: toInteger/fromIntegral can cause unexpected truncation, as Integer is arbitrarily bounded during synthesis. Prefer bitCoerce and the Resize class.

Defined in Clash.Sized.Internal.Index

Methods

quot :: Index n -> Index n -> Index n

rem :: Index n -> Index n -> Index n

div :: Index n -> Index n -> Index n

mod :: Index n -> Index n -> Index n

quotRem :: Index n -> Index n -> (Index n, Index n)

divMod :: Index n -> Index n -> (Index n, Index n)

toInteger :: Index n -> Integer

KnownNat n => Data (Index n)

Defined in Clash.Sized.Internal.Index

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Index n -> c (Index n)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Index n)

toConstr :: Index n -> Constr

dataTypeOf :: Index n -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Index n))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Index n))

gmapT :: (forall b. Data b => b -> b) -> Index n -> Index n

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Index n -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Index n -> r

gmapQ :: (forall d. Data d => d -> u) -> Index n -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Index n -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Index n -> m (Index n)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Index n -> m (Index n)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Index n -> m (Index n)

KnownNat n => Num (Index n)

Operators report an error on overflow and underflow

NB: fromInteger/fromIntegral can cause unexpected truncation, as Integer is arbitrarily bounded during synthesis. Prefer bitCoerce and the Resize class.

Defined in Clash.Sized.Internal.Index

Methods

(+) :: Index n -> Index n -> Index n

(-) :: Index n -> Index n -> Index n

(*) :: Index n -> Index n -> Index n

negate :: Index n -> Index n

abs :: Index n -> Index n

signum :: Index n -> Index n

fromInteger :: Integer -> Index n

Ord (Index n)

Defined in Clash.Sized.Internal.Index

Methods

compare :: Index n -> Index n -> Ordering

(<) :: Index n -> Index n -> Bool

(<=) :: Index n -> Index n -> Bool

(>) :: Index n -> Index n -> Bool

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

max :: Index n -> Index n -> Index n

min :: Index n -> Index n -> Index n

KnownNat n => Read (Index n)

None of the Read class' methods are synthesizable.

Defined in Clash.Sized.Internal.Index

Methods

readsPrec :: Int -> ReadS (Index n)

readList :: ReadS [Index n]

readPrec :: ReadPrec (Index n)

readListPrec :: ReadPrec [Index n]

KnownNat n => Real (Index n)

Defined in Clash.Sized.Internal.Index

Methods

toRational :: Index n -> Rational

Show (Index n)

Defined in Clash.Sized.Internal.Index

Methods

showsPrec :: Int -> Index n -> ShowS

show :: Index n -> String

showList :: [Index n] -> ShowS

KnownNat n => Ix (Index n)

Defined in Clash.Sized.Internal.Index

Methods

range :: (Index n, Index n) -> [Index n]

index :: (Index n, Index n) -> Index n -> Int

unsafeIndex :: (Index n, Index n) -> Index n -> Int

inRange :: (Index n, Index n) -> Index n -> Bool

rangeSize :: (Index n, Index n) -> Int

unsafeRangeSize :: (Index n, Index n) -> Int

Generic (Index n)

Defined in Clash.Sized.Internal.Index

Associated Types

type Rep (Index n) :: Type -> Type

Methods

from :: Index n -> Rep (Index n) x

to :: Rep (Index n) x -> Index n

KnownNat n => Arbitrary (Index n)

Defined in Clash.Sized.Internal.Index

Methods

arbitrary :: Gen (Index n)

shrink :: Index n -> [Index n]

KnownNat n => CoArbitrary (Index n)

Defined in Clash.Sized.Internal.Index

Methods

coarbitrary :: Index n -> Gen b -> Gen b

KnownNat n => PrintfArg (Index n)

Defined in Clash.Sized.Internal.Index

Methods

formatArg :: Index n -> FieldFormatter

parseFormat :: Index n -> ModifierParser

(KnownNat n, 1 <= n) => Bits (Index n)

Defined in Clash.Sized.Internal.Index

Methods

(.&.) :: Index n -> Index n -> Index n

(.|.) :: Index n -> Index n -> Index n

xor :: Index n -> Index n -> Index n

complement :: Index n -> Index n

shift :: Index n -> Int -> Index n

rotate :: Index n -> Int -> Index n

zeroBits :: Index n

bit :: Int -> Index n

setBit :: Index n -> Int -> Index n

clearBit :: Index n -> Int -> Index n

complementBit :: Index n -> Int -> Index n

testBit :: Index n -> Int -> Bool

bitSizeMaybe :: Index n -> Maybe Int

bitSize :: Index n -> Int

isSigned :: Index n -> Bool

shiftL :: Index n -> Int -> Index n

unsafeShiftL :: Index n -> Int -> Index n

shiftR :: Index n -> Int -> Index n

unsafeShiftR :: Index n -> Int -> Index n

rotateL :: Index n -> Int -> Index n

rotateR :: Index n -> Int -> Index n

popCount :: Index n -> Int

(KnownNat n, 1 <= n) => FiniteBits (Index n)

Defined in Clash.Sized.Internal.Index

Methods

finiteBitSize :: Index n -> Int

countLeadingZeros :: Index n -> Int

countTrailingZeros :: Index n -> Int

KnownNat n => Default (Index n)

Defined in Clash.Sized.Internal.Index

Methods

def :: Index n

NFData (Index n)

Defined in Clash.Sized.Internal.Index

Methods

rnf :: Index n -> ()

(KnownNat n, 1 <= n) => SaturatingNum (Index n)

Defined in Clash.Sized.Internal.Index

Methods

satAdd :: SaturationMode -> Index n -> Index n -> Index n

satSub :: SaturationMode -> Index n -> Index n -> Index n

satMul :: SaturationMode -> Index n -> Index n -> Index n

satSucc :: SaturationMode -> Index n -> Index n

satPred :: SaturationMode -> Index n -> Index n

NFDataX (Index n)

Defined in Clash.Sized.Internal.Index

Methods

deepErrorX :: String -> Index n

hasUndefined :: Index n -> Bool

ensureSpine :: Index n -> Index n

rnfX :: Index n -> ()

ShowX (Index n)

Defined in Clash.Sized.Internal.Index

Methods

showsPrecX :: Int -> Index n -> ShowS

showX :: Index n -> String

showListX :: [Index n] -> ShowS

(KnownNat n, 1 <= n) => BitPack (Index n)

Defined in Clash.Sized.Internal.Index

Associated Types

type BitSize (Index n) :: Nat

Methods

pack :: Index n -> BitVector (BitSize (Index n))

unpack :: BitVector (BitSize (Index n)) -> Index n

(KnownNat n, 1 <= n) => Parity (Index n)

Defined in Clash.Sized.Internal.Index

Methods

even :: Index n -> Bool

odd :: Index n -> Bool

Bundle (Index n)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled dom (Index n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain). Unbundled dom (Index n) -> Signal dom (Index n)

unbundle :: forall (dom :: Domain). Signal dom (Index n) -> Unbundled dom (Index n)

Bundle (Index n)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Index n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Index n) -> DSignal dom d (Index n)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Index n) -> Unbundled dom d (Index n)

(1 <= n, KnownNat n) => Counter (Index n)

Defined in Clash.Class.Counter.Internal

Methods

countMin :: Index n

countMax :: Index n

countSuccOverflow :: Index n -> (Bool, Index n)

countPredOverflow :: Index n -> (Bool, Index n)

AutoReg (Index n)

Defined in Clash.Class.AutoReg.Internal

Methods

autoReg :: forall (dom :: Domain). (HasCallStack, KnownDomain dom) => Clock dom -> Reset dom -> Enable dom -> Index n -> Signal dom (Index n) -> Signal dom (Index n)

KnownNat m => Exp (Index m)

Defined in Clash.Class.Exp

Associated Types

type ExpResult (Index m) n

Methods

(^) :: forall (n :: Nat). Index m -> SNat n -> ExpResult (Index m) n

ExtendingNum (Index m) (Index n)

Defined in Clash.Sized.Internal.Index

Associated Types

type AResult (Index m) (Index n)

type MResult (Index m) (Index n)

Methods

add :: Index m -> Index n -> AResult (Index m) (Index n)

sub :: Index m -> Index n -> AResult (Index m) (Index n)

mul :: Index m -> Index n -> MResult (Index m) (Index n)

type Unbundled dom d (Index n)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Index n) = DSignal dom d (Index n)

type Unbundled dom (Index n)

Defined in Clash.Signal.Bundle

type Unbundled dom (Index n) = Signal dom (Index n)

type TryDomain t (Index n)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Index n) = 'NotFound

type Rep (Index n)

Defined in Clash.Sized.Internal.Index

type Rep (Index n) = D1 ('MetaData "Index" "Clash.Sized.Internal.Index" "clash-prelude-1.8.1-inplace" 'True) (C1 ('MetaCons "I" 'PrefixI 'True) (S1 ('MetaSel ('Just "unsafeToInteger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

type BitSize (Index n)

Defined in Clash.Sized.Internal.Index

type BitSize (Index n) = CLog 2 n

type ExpResult (Index m) n

Defined in Clash.Class.Exp

type ExpResult (Index m) n = Index (Max 2 (m ^ n))

type AResult (Index m) (Index n)

Defined in Clash.Sized.Internal.Index

type AResult (Index m) (Index n) = Index ((m + n) - 1)

type MResult (Index m) (Index n)

Defined in Clash.Sized.Internal.Index

type MResult (Index m) (Index n) = Index (((m - 1) * (n - 1)) + 1)

Construction

fromSNat :: (KnownNat m, (n + 1) <= m) => SNat n -> Index m

Safely convert an SNat value to an Index

Accessors

Length information

size# :: (KnownNat n, 1 <= n) => Index n -> Int

Type classes

BitPack

pack# :: Index n -> BitVector (CLog 2 n)

unpack# :: (KnownNat n, 1 <= n) => BitVector (CLog 2 n) -> Index n

Eq

eq# :: Index n -> Index n -> Bool

neq# :: Index n -> Index n -> Bool

Ord

lt# :: Index n -> Index n -> Bool

ge# :: Index n -> Index n -> Bool

gt# :: Index n -> Index n -> Bool

le# :: Index n -> Index n -> Bool

Enum

toEnum# :: forall n. KnownNat n => Int -> Index n

fromEnum# :: forall n. KnownNat n => Index n -> Int

Enum (not synthesizable)

enumFrom# :: forall n. KnownNat n => Index n -> [Index n]

enumFromThen# :: forall n. KnownNat n => Index n -> Index n -> [Index n]

enumFromTo# :: Index n -> Index n -> [Index n]

enumFromThenTo# :: Index n -> Index n -> Index n -> [Index n]

Bounded

maxBound# :: forall n. KnownNat n => Index n

Num

(+#) :: KnownNat n => Index n -> Index n -> Index n

(-#) :: KnownNat n => Index n -> Index n -> Index n

(*#) :: KnownNat n => Index n -> Index n -> Index n

negate# :: KnownNat n => Index n -> Index n

fromInteger# :: KnownNat n => Integer -> Index n

ExtendingNum

plus# :: Index m -> Index n -> Index ((m + n) - 1)

minus# :: Index m -> Index n -> Index ((m + n) - 1)

times# :: Index m -> Index n -> Index (((m - 1) * (n - 1)) + 1)

Integral

quot# :: Index n -> Index n -> Index n

rem# :: Index n -> Index n -> Index n

toInteger# :: Index n -> Integer

Resize

resize# :: KnownNat m => Index n -> Index m