clash-prelude
Copyright(C) 2013-2016 University of Twente
2016 Myrtle Software Ltd
2021-2025 QBayLogic B.V.
LicenseBSD2 (see the file LICENSE)
MaintainerQBayLogic B.V. <devops@qbaylogic.com>
Safe HaskellUnsafe
LanguageHaskell2010
Extensions
  • Cpp
  • UndecidableInstances
  • MonoLocalBinds
  • TemplateHaskell
  • TemplateHaskellQuotes
  • ScopedTypeVariables
  • BangPatterns
  • TypeFamilies
  • ViewPatterns
  • PolyKinds
  • DataKinds
  • InstanceSigs
  • StandaloneDeriving
  • DeriveDataTypeable
  • DeriveFunctor
  • DeriveTraversable
  • DeriveFoldable
  • DeriveGeneric
  • DefaultSignatures
  • DeriveAnyClass
  • DeriveLift
  • DerivingStrategies
  • TypeSynonymInstances
  • FlexibleInstances
  • ConstrainedClassMethods
  • MultiParamTypeClasses
  • MagicHash
  • KindSignatures
  • RoleAnnotations
  • PostfixOperators
  • TupleSections
  • TypeOperators
  • ExplicitNamespaces
  • ExplicitForAll
  • MultiWayIf
  • BinaryLiterals
  • TypeApplications

Clash.Sized.Internal.Unsigned

Description

 
Synopsis

Datatypes

data Unsigned (n :: Nat) Source #

Arbitrary-width unsigned integer represented by n bits

Given n bits, an Unsigned n number has a range of: [0 .. 2^n-1]

>>> maxBound :: Unsigned 3
7
>>> minBound :: Unsigned 3
0
>>> read (show (maxBound :: Unsigned 3)) :: Unsigned 3
7
>>> 1 + 2 :: Unsigned 3
3
>>> 2 + 6 :: Unsigned 3
0
>>> 1 - 3 :: Unsigned 3
6
>>> 2 * 3 :: Unsigned 3
6
>>> 2 * 4 :: Unsigned 3
0
>>> (2 :: Unsigned 3) `mul` (4 :: Unsigned 3) :: Unsigned 6
8
>>> (2 :: Unsigned 3) `add` (6 :: Unsigned 3) :: Unsigned 4
8
>>> satAdd SatSymmetric 2 6 :: Unsigned 3
7
>>> satSub SatSymmetric 2 3 :: Unsigned 3
0

Unsigned has the type role

>>> :i Unsigned
type role Unsigned nominal
...

as it is not safe to coerce between different width Unsigned. To change the width, use the functions in the Resize class.

Constructors

U

The constructor, U, and the field, unsafeToNatural, are not synthesizable.

Instances

Instances details
Resize Unsigned Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

resize :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned b Source #

extend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned (b + a) Source #

zeroExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned (b + a) Source #

signExtend :: forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Unsigned a -> Unsigned (b + a) Source #

truncateB :: forall (a :: Nat) (b :: Natural). KnownNat a => Unsigned (a + b) -> Unsigned a Source #

(UFixedNegativeLiteralError ('Text str) :: Constraint) => CheckedNegativeRationalLiteral str num den (UFixed int frac) Source # 
Instance details

Defined in Clash.Sized.Fixed

(Assert (If (Div num den <=? 0) (Div num den <=? 0) (CLog 2 (Div num den + 1) <=? int)) (UFixedPositiveLiteralError ('Text str) (Div num den) int :: Constraint), CheckFixedFrac (IsPowerOfTwo den) ('Text str) den frac (UFixed int frac)) => CheckedPositiveRationalLiteral str num den (UFixed int frac) Source # 
Instance details

Defined in Clash.Sized.Fixed

(NegativeUnsignedError lit (Unsigned n) ((2 ^ n) - 1) :: Constraint) => CheckedNegativeIntegerLiteral lit (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Assert (If (lit <=? 0) (lit <=? 0) (CLog 2 (lit + 1) <=? n)) (UnsignedPositiveLiteralError lit n :: Constraint) => CheckedPositiveIntegerLiteral lit (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

NumConvertCanonical Word16 (Unsigned 16) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical Word32 (Unsigned 32) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical Word64 (Unsigned 64) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical Word8 (Unsigned 8) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical Word (Unsigned 64) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

KnownNat n => Lift (Unsigned n :: Type) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

lift :: Quote m => Unsigned n -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Unsigned n -> Code m (Unsigned n) #

(UFixedNegativeLiteralError ('Text "-" ':<>: 'ShowType lit) :: Constraint) => CheckedNegativeIntegerLiteral lit (UFixed int frac) Source # 
Instance details

Defined in Clash.Sized.Fixed

Assert (If (lit <=? 0) (lit <=? 0) (CLog 2 (lit + 1) <=? int)) (UFixedPositiveLiteralError ('ShowType lit) lit int :: Constraint) => CheckedPositiveIntegerLiteral lit (UFixed int frac) Source # 
Instance details

Defined in Clash.Sized.Fixed

KnownNat n => Arbitrary (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

arbitrary :: Gen (Unsigned n) #

shrink :: Unsigned n -> [Unsigned n] #

KnownNat n => CoArbitrary (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

coarbitrary :: Unsigned n -> Gen b -> Gen b #

KnownNat n => Data (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

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

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

toConstr :: Unsigned n -> Constr #

dataTypeOf :: Unsigned n -> DataType #

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

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

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

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

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

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

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

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

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

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

KnownNat n => Bits (Unsigned n) Source #

shiftR a n:

Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => FiniteBits (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => Bounded (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => Enum (Unsigned n) Source #

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

Instance details

Defined in Clash.Sized.Internal.Unsigned

Generic (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Associated Types

type Rep (Unsigned n) :: Type -> Type #

Methods

from :: Unsigned n -> Rep (Unsigned n) x #

to :: Rep (Unsigned n) x -> Unsigned n #

KnownNat n => Ix (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => Num (Unsigned n) Source #

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

Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => Read (Unsigned n) Source #

None of the Read class' methods are synthesizable.

Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => Integral (Unsigned n) Source #

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

Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => Real (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

toRational :: Unsigned n -> Rational #

Show (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

showsPrec :: Int -> Unsigned n -> ShowS #

show :: Unsigned n -> String #

showList :: [Unsigned n] -> ShowS #

KnownNat n => PrintfArg (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

AutoReg (Unsigned n) Source # 
Instance details

Defined in Clash.Class.AutoReg.Internal

Methods

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

KnownNat n => BitPack (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Associated Types

type BitSize (Unsigned n) :: Nat Source #

KnownNat n => Counter (Unsigned n) Source # 
Instance details

Defined in Clash.Class.Counter.Internal

KnownNat m => Exp (Unsigned m) Source # 
Instance details

Defined in Clash.Class.Exp

Associated Types

type ExpResult (Unsigned m) n Source #

Methods

(^) :: forall (n :: Nat). Unsigned m -> SNat n -> ExpResult (Unsigned m) n Source #

KnownNat n => SaturatingNum (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

KnownNat n => Parity (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

even :: Unsigned n -> Bool Source #

odd :: Unsigned n -> Bool Source #

Bundle (Unsigned n) Source # 
Instance details

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled dom (Unsigned n) = (res :: Type) Source #

Methods

bundle :: forall (dom :: Domain). Unbundled dom (Unsigned n) -> Signal dom (Unsigned n) Source #

unbundle :: forall (dom :: Domain). Signal dom (Unsigned n) -> Unbundled dom (Unsigned n) Source #

Bundle (Unsigned n) Source # 
Instance details

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Unsigned n) = (res :: Type) Source #

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Unsigned n) -> DSignal dom d (Unsigned n) Source #

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Unsigned n) -> Unbundled dom d (Unsigned n) Source #

NFDataX (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

ShowX (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Default (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

def :: Unsigned n #

NFData (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

rnf :: Unsigned n -> () #

Eq (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

(==) :: Unsigned n -> Unsigned n -> Bool #

(/=) :: Unsigned n -> Unsigned n -> Bool #

Ord (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

compare :: Unsigned n -> Unsigned n -> Ordering #

(<) :: Unsigned n -> Unsigned n -> Bool #

(<=) :: Unsigned n -> Unsigned n -> Bool #

(>) :: Unsigned n -> Unsigned n -> Bool #

(>=) :: Unsigned n -> Unsigned n -> Bool #

max :: Unsigned n -> Unsigned n -> Unsigned n #

min :: Unsigned n -> Unsigned n -> Unsigned n #

KnownNat n => Ixed (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Methods

ix :: Index (Unsigned n) -> Traversal' (Unsigned n) (IxValue (Unsigned n)) #

NumConvertCanonical (Unsigned 8) Word8 Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical (Unsigned 16) Word16 Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical (Unsigned 32) Word32 Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical (Unsigned 64) Word64 Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

NumConvertCanonical (Unsigned 64) Word Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

(KnownNat m, KnownNat n) => ExtendingNum (Unsigned m) (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

Associated Types

type AResult (Unsigned m) (Unsigned n) Source #

type MResult (Unsigned m) (Unsigned n) Source #

(KnownNat n, KnownNat m) => MaybeNumConvertCanonical (BitVector n) (Unsigned m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.MaybeNumConvert

(KnownNat n, KnownNat m) => MaybeNumConvertCanonical (Index n) (Unsigned m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.MaybeNumConvert

(KnownNat n, KnownNat m) => MaybeNumConvertCanonical (Signed n) (Unsigned m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.MaybeNumConvert

(KnownNat n, KnownNat m) => MaybeNumConvertCanonical (Unsigned n) (BitVector m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.MaybeNumConvert

(KnownNat n, KnownNat m) => MaybeNumConvertCanonical (Unsigned n) (Index m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.MaybeNumConvert

(KnownNat n, KnownNat m) => MaybeNumConvertCanonical (Unsigned n) (Signed m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.MaybeNumConvert

(KnownNat n, KnownNat m) => MaybeNumConvertCanonical (Unsigned n) (Unsigned m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.MaybeNumConvert

(KnownNat n, KnownNat m, n <= m) => NumConvertCanonical (BitVector n) (Unsigned m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

(KnownNat n, KnownNat m, n <= (2 ^ m)) => NumConvertCanonical (Index n) (Unsigned m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

(KnownNat n, KnownNat m, n <= m) => NumConvertCanonical (Unsigned n) (BitVector m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

(KnownNat n, KnownNat m, (2 ^ n) <= m) => NumConvertCanonical (Unsigned n) (Index m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

(KnownNat n, KnownNat m, (n + 1) <= m) => NumConvertCanonical (Unsigned n) (Signed m) Source #

Note: Conversion from Unsigned 0 to Signed 0 is lossless, but not within the constraints of the instance.

Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

(KnownNat n, KnownNat m, n <= m) => NumConvertCanonical (Unsigned n) (Unsigned m) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.NumConvert

type Unbundled dom d (Unsigned n) Source # 
Instance details

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Unsigned n) = DSignal dom d (Unsigned n)
type TryDomain t (Unsigned n) Source # 
Instance details

Defined in Clash.Class.HasDomain.HasSingleDomain

type Unbundled dom (Unsigned n) Source # 
Instance details

Defined in Clash.Signal.Bundle

type Unbundled dom (Unsigned n) = Signal dom (Unsigned n)
type Rep (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

type Rep (Unsigned n) = D1 ('MetaData "Unsigned" "Clash.Sized.Internal.Unsigned" "clash-prelude-1.11.0-inplace" 'False) (C1 ('MetaCons "U" 'PrefixI 'True) (S1 ('MetaSel ('Just "unsafeToNatural") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural)))
type BitSize (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

type BitSize (Unsigned n) = n
type Canonical (Unsigned n) Source # 
Instance details

Defined in Clash.Class.NumConvert.Internal.Canonical

type Index (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

type Index (Unsigned n) = Int
type IxValue (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

type IxValue (Unsigned n) = Bit
type ExpResult (Unsigned m) n Source # 
Instance details

Defined in Clash.Class.Exp

type ExpResult (Unsigned m) n = Unsigned (Max 1 (m * n))
type AResult (Unsigned m) (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

type AResult (Unsigned m) (Unsigned n) = Unsigned (Max m n + 1)
type MResult (Unsigned m) (Unsigned n) Source # 
Instance details

Defined in Clash.Sized.Internal.Unsigned

type MResult (Unsigned m) (Unsigned n) = Unsigned (m + n)

Accessors

Length information

Type classes

BitPack

Eq

Ord

Enum

toEnum# :: forall n. KnownNat n => Int -> Unsigned n Source #

fromEnum# :: forall n. KnownNat n => Unsigned n -> Int Source #

Enum (not synthesizable)

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

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

enumFromTo# :: forall n. KnownNat n => Unsigned n -> Unsigned n -> [Unsigned n] Source #

enumFromThenTo# :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n -> [Unsigned n] Source #

Bounded

maxBound# :: forall n. KnownNat n => Unsigned n Source #

Num

(+#) :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n Source #

(-#) :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n Source #

(*#) :: forall n. KnownNat n => Unsigned n -> Unsigned n -> Unsigned n Source #

negate# :: forall n. KnownNat n => Unsigned n -> Unsigned n Source #

fromInteger# :: forall n. KnownNat n => Integer -> Unsigned n Source #

ExtendingNum

plus# :: Unsigned m -> Unsigned n -> Unsigned (Max m n + 1) Source #

minus# :: forall m n. (KnownNat m, KnownNat n) => Unsigned m -> Unsigned n -> Unsigned (Max m n + 1) Source #

Integral

Bits

complement# :: forall n. KnownNat n => Unsigned n -> Unsigned n Source #

shiftL# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n Source #

shiftR# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n Source #

rotateL# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n Source #

rotateR# :: forall n. KnownNat n => Unsigned n -> Int -> Unsigned n Source #

Resize

resize# :: forall n m. KnownNat m => Unsigned n -> Unsigned m Source #

Conversions

Type-level error messages