Main memory units type. It has phantom type parameter mem of kind Nat which is type level representation of the unit. Stores internally memory as bits. To construct values of type Memory, use functions from the Membrain.Constructors module.

Creates Memory of unit mem by the given Natural number. Memorys smart constructor.

>>> memory @Byte 3
Memory {unMemory = 24}

Convert memory from one unit to another.

Note: this changes only view, not model. So this operation has zero runtime cost.

>>> showMemory $ toMemory @Kilobyte $ byte 100
"0.1kB"
>>> showMemory $ toMemory @Kibibyte $ byte 100
"0.09765625KiB"

This showMemory function shows a Memory value as Double along with the measure unit suffix. It shows Memory losslessly while used with standardized units of measurements. The following mathematical law is used to display Memory:

A decimal representation written with a repeating final 0 is supposed to terminate before these zeros. Instead of 1.585000... one simply writes 1.585. The decimal is also called a terminating decimal. Terminating decimals represent rational numbers of the form \( \cfrac{k}{2^n 5^m} \). If you use different forms of units then the show function for Memory hangs.

>>> showMemory (Memory 22 :: Memory Byte)
"2.75B"

Inverse of showMemory.

>>> readMemory @Byte "2.75B"
Just (Memory {unMemory = 22})
>>> readMemory @Bit "2.75B"
Nothing

Lossless Memory conversion to bits. Alias to unMemory.

>>> toBits $ byte 1
8
>>> toBits $ kilobyte 1
8000

Lossless Memory conversion to rational number.

>>> toRat $ byte 4
4 % 1
>>> toRat $ toMemory @Byte $ bit 22
11 % 4

Floor Memory unit to integral number. This function may lose some information, so use only when:

1. You don't care about losing information.
2. You are sure that there will be no loss.

>>> floor $ byte 4
4
>>> floor $ toMemory @Byte $ bit 22
2

Returns the result of multiplication Natural with the given Memory value

>>> memoryMul 2 (byte 4)
Memory {unMemory = 64}

Returns the result of comparison of two Memory values and the difference between them as another Memory of the same unit.

>>> memoryDiff (bit 4) (bit 8)
(LT,Memory {unMemory = 4})
>>> memoryDiff (byte 8) (byte 4)
(GT,Memory {unMemory = 32})
>>> memoryDiff (kilobyte 2) (kilobyte 2)
(EQ,Memory {unMemory = 0})

Returns the result of addition of two Memory values casted to the second memory unit.

>>> memoryPlus (bit 8) (megabyte 2)
Memory {unMemory = 16000008}

Retuns the result of division of two Memory values of any units.

>>> memoryDiv (kilobyte 3) (byte 2)
1500 % 1

Existential data type for Memorys.