mirror of
https://github.com/GaloisInc/cryptol.git
synced 2024-09-23 11:58:47 +03:00
87d5edab00
* Add docstrings for all prelude functions and fix minor style issues. Fixes #771 * Update `CryptolPrims` documentation * Minor updates to the prelude * Update CHANGES * Updates to the cryptol book and CryptolPrims * Fix several additional docstrings * Specify and document properties of signed bitvector division. Fixes #677 * Fixup test * typos and style * Regenerate PDFs
208 lines
7.2 KiB
Plaintext
208 lines
7.2 KiB
Plaintext
Loading module Cryptol
|
|
Loading module Cryptol
|
|
Loading module issue226r2
|
|
Loading module issue226
|
|
Type Synonyms
|
|
=============
|
|
|
|
From Cryptol
|
|
------------
|
|
|
|
type Bool = Bit
|
|
type Char = [8]
|
|
type lg2 n = width (max 1 n - 1)
|
|
type String n = [n]Char
|
|
type Word n = [n]
|
|
|
|
Constraint Synonyms
|
|
===================
|
|
|
|
From Cryptol
|
|
------------
|
|
|
|
type constraint i < j = j >= 1 + i
|
|
type constraint i <= j = j >= i
|
|
type constraint i > j = i >= 1 + j
|
|
|
|
Primitive Types
|
|
===============
|
|
|
|
From Cryptol
|
|
------------
|
|
|
|
(!=) : # -> # -> Prop
|
|
(==) : # -> # -> Prop
|
|
(>=) : # -> # -> Prop
|
|
(+) : # -> # -> #
|
|
(-) : # -> # -> #
|
|
(%) : # -> # -> #
|
|
(%^) : # -> # -> #
|
|
(*) : # -> # -> #
|
|
(/) : # -> # -> #
|
|
(/^) : # -> # -> #
|
|
(^^) : # -> # -> #
|
|
Bit : *
|
|
Cmp : * -> Prop
|
|
Eq : * -> Prop
|
|
FLiteral : # -> # -> # -> * -> Prop
|
|
Field : * -> Prop
|
|
fin : # -> Prop
|
|
Integer : *
|
|
Integral : * -> Prop
|
|
inf : #
|
|
Literal : # -> * -> Prop
|
|
Logic : * -> Prop
|
|
lengthFromThenTo : # -> # -> # -> #
|
|
max : # -> # -> #
|
|
min : # -> # -> #
|
|
Rational : *
|
|
Ring : * -> Prop
|
|
Round : * -> Prop
|
|
SignedCmp : * -> Prop
|
|
width : # -> #
|
|
Z : # -> *
|
|
Zero : * -> Prop
|
|
|
|
Symbols
|
|
=======
|
|
|
|
Public
|
|
------
|
|
|
|
foo : {a} a -> a
|
|
|
|
From Cryptol
|
|
------------
|
|
|
|
(/.) : {a} (Field a) => a -> a -> a
|
|
(==>) : Bit -> Bit -> Bit
|
|
(\/) : Bit -> Bit -> Bit
|
|
(/\) : Bit -> Bit -> Bit
|
|
(!=) : {a} (Eq a) => a -> a -> Bit
|
|
(!==) : {a, b} (Eq b) => (a -> b) -> (a -> b) -> a -> Bit
|
|
(==) : {a} (Eq a) => a -> a -> Bit
|
|
(===) : {a, b} (Eq b) => (a -> b) -> (a -> b) -> a -> Bit
|
|
(<) : {a} (Cmp a) => a -> a -> Bit
|
|
(<$) : {a} (SignedCmp a) => a -> a -> Bit
|
|
(<=) : {a} (Cmp a) => a -> a -> Bit
|
|
(<=$) : {a} (SignedCmp a) => a -> a -> Bit
|
|
(>) : {a} (Cmp a) => a -> a -> Bit
|
|
(>$) : {a} (SignedCmp a) => a -> a -> Bit
|
|
(>=) : {a} (Cmp a) => a -> a -> Bit
|
|
(>=$) : {a} (SignedCmp a) => a -> a -> Bit
|
|
(||) : {a} (Logic a) => a -> a -> a
|
|
(^) : {a} (Logic a) => a -> a -> a
|
|
(&&) : {a} (Logic a) => a -> a -> a
|
|
(#) :
|
|
{front, back, a} (fin front) =>
|
|
[front]a -> [back]a -> [front + back]a
|
|
(<<) : {n, ix, a} (Integral ix, Zero a) => [n]a -> ix -> [n]a
|
|
(<<<) : {n, ix, a} (fin n, Integral ix) => [n]a -> ix -> [n]a
|
|
(>>) : {n, ix, a} (Integral ix, Zero a) => [n]a -> ix -> [n]a
|
|
(>>$) : {n, ix} (fin n, n >= 1, Integral ix) => [n] -> ix -> [n]
|
|
(>>>) : {n, ix, a} (fin n, Integral ix) => [n]a -> ix -> [n]a
|
|
(+) : {a} (Ring a) => a -> a -> a
|
|
(-) : {a} (Ring a) => a -> a -> a
|
|
(%) : {a} (Integral a) => a -> a -> a
|
|
(%$) : {n} (fin n, n >= 1) => [n] -> [n] -> [n]
|
|
(*) : {a} (Ring a) => a -> a -> a
|
|
(/) : {a} (Integral a) => a -> a -> a
|
|
(/$) : {n} (fin n, n >= 1) => [n] -> [n] -> [n]
|
|
(^^) : {a, e} (Ring a, Integral e) => a -> e -> a
|
|
(!) : {n, a, ix} (fin n, Integral ix) => [n]a -> ix -> a
|
|
(!!) : {n, k, ix, a} (fin n, Integral ix) => [n]a -> [k]ix -> [k]a
|
|
(@) : {n, a, ix} (Integral ix) => [n]a -> ix -> a
|
|
(@@) : {n, k, ix, a} (Integral ix) => [n]a -> [k]ix -> [k]a
|
|
abs : {a} (Cmp a, Ring a) => a -> a
|
|
all : {n, a} (fin n) => (a -> Bit) -> [n]a -> Bit
|
|
and : {n} (fin n) => [n] -> Bit
|
|
any : {n, a} (fin n) => (a -> Bit) -> [n]a -> Bit
|
|
assert : {a, n} (fin n) => Bit -> String n -> a -> a
|
|
carry : {n} (fin n) => [n] -> [n] -> Bit
|
|
ceiling : {a} (Round a) => a -> Integer
|
|
complement : {a} (Logic a) => a -> a
|
|
curry : {a, b, c} ((a, b) -> c) -> a -> b -> c
|
|
demote : {val, rep} (Literal val rep) => rep
|
|
drop : {front, back, a} (fin front) => [front + back]a -> [back]a
|
|
elem : {n, a} (fin n, Eq a) => a -> [n]a -> Bit
|
|
error : {a, n} (fin n) => String n -> a
|
|
False : Bit
|
|
floor : {a} (Round a) => a -> Integer
|
|
foldl : {n, a, b} (fin n) => (a -> b -> a) -> a -> [n]b -> a
|
|
foldr : {n, a, b} (fin n) => (a -> b -> b) -> b -> [n]a -> b
|
|
fraction : {m, n, r, a} (FLiteral m n r a) => a
|
|
fromInteger : {a} (Ring a) => Integer -> a
|
|
fromThenTo :
|
|
{first, next, last, a, len} (fin first, fin next, fin last,
|
|
Literal first a, Literal next a, Literal last a, first != next,
|
|
lengthFromThenTo first next last == len) =>
|
|
[len]a
|
|
fromTo :
|
|
{first, last, a} (fin last, last >= first, Literal first a,
|
|
Literal last a) =>
|
|
[1 + (last - first)]a
|
|
fromZ : {n} (fin n, n >= 1) => Z n -> Integer
|
|
generate : {n, a} (fin n, n >= 1) => (Integer -> a) -> [n]a
|
|
groupBy :
|
|
{each, parts, a} (fin each) => [each * parts]a -> [parts][each]a
|
|
head : {n, a} [1 + n]a -> a
|
|
infFrom : {a} (Integral a) => a -> [inf]a
|
|
infFromThen : {a} (Integral a) => a -> a -> [inf]a
|
|
iterate : {a} (a -> a) -> a -> [inf]a
|
|
join :
|
|
{parts, each, a} (fin each) => [parts][each]a -> [parts * each]a
|
|
last : {n, a} (fin n) => [1 + n]a -> a
|
|
length : {n, a, b} (fin n, Literal n b) => [n]a -> b
|
|
lg2 : {n} (fin n) => [n] -> [n]
|
|
map : {n, a, b} (a -> b) -> [n]a -> [n]b
|
|
max : {a} (Cmp a) => a -> a -> a
|
|
min : {a} (Cmp a) => a -> a -> a
|
|
negate : {a} (Ring a) => a -> a
|
|
number : {val, rep} (Literal val rep) => rep
|
|
or : {n} (fin n) => [n] -> Bit
|
|
pdiv : {u, v} (fin u, fin v) => [u] -> [v] -> [u]
|
|
pmod : {u, v} (fin u, fin v) => [u] -> [1 + v] -> [v]
|
|
pmult :
|
|
{u, v} (fin u, fin v) => [1 + u] -> [1 + v] -> [1 + (u + v)]
|
|
random : {a} [256] -> a
|
|
ratio : Integer -> Integer -> Rational
|
|
recip : {a} (Field a) => a -> a
|
|
repeat : {n, a} a -> [n]a
|
|
reverse : {n, a} (fin n) => [n]a -> [n]a
|
|
roundAway : {a} (Round a) => a -> Integer
|
|
roundToEven : {a} (Round a) => a -> Integer
|
|
sborrow : {n} (fin n, n >= 1) => [n] -> [n] -> Bit
|
|
scanl : {n, b, a} (b -> a -> b) -> b -> [n]a -> [1 + n]b
|
|
scanr : {n, a, b} (fin n) => (a -> b -> b) -> b -> [n]a -> [1 + n]b
|
|
scarry : {n} (fin n, n >= 1) => [n] -> [n] -> Bit
|
|
sext : {m, n} (fin m, m >= n, n >= 1) => [n] -> [m]
|
|
split :
|
|
{parts, each, a} (fin each) => [parts * each]a -> [parts][each]a
|
|
splitAt :
|
|
{front, back, a} (fin front) =>
|
|
[front + back]a -> ([front]a, [back]a)
|
|
sum : {n, a} (fin n, Ring a) => [n]a -> a
|
|
True : Bit
|
|
tail : {n, a} [1 + n]a -> [n]a
|
|
take : {front, back, a} (fin front) => [front + back]a -> [front]a
|
|
toInteger : {a} (Integral a) => a -> Integer
|
|
trace : {n, a, b} (fin n) => String n -> a -> b -> b
|
|
traceVal : {n, a} (fin n) => String n -> a -> a
|
|
transpose : {rows, cols, a} [rows][cols]a -> [cols][rows]a
|
|
trunc : {a} (Round a) => a -> Integer
|
|
uncurry : {a, b, c} (a -> b -> c) -> (a, b) -> c
|
|
undefined : {a} a
|
|
update : {n, a, ix} (Integral ix) => [n]a -> ix -> a -> [n]a
|
|
updateEnd :
|
|
{n, a, ix} (fin n, Integral ix) => [n]a -> ix -> a -> [n]a
|
|
updates :
|
|
{n, k, ix, a} (Integral ix, fin k) => [n]a -> [k]ix -> [k]a -> [n]a
|
|
updatesEnd :
|
|
{n, k, ix, a} (fin n, Integral ix, fin k) =>
|
|
[n]a -> [k]ix -> [k]a -> [n]a
|
|
zero : {a} (Zero a) => a
|
|
zext : {m, n} (fin m, m >= n) => [n] -> [m]
|
|
zip : {n, a, b} [n]a -> [n]b -> [n](a, b)
|
|
zipWith : {n, a, b, c} (a -> b -> c) -> [n]a -> [n]b -> [n]c
|
|
|