package bap-knowledge

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

bap-knowledge
- Bap_knowledge
  - Knowledge
    
    Agent
    
    Class
    
    Collection
    
    Delay
    
    T
    
    Eager
    
    T
    
    S
    
    Conflict
    
    Documentation
    
    Agent
    
    Class
    
    Element
    
    Property
    
    Rule
    
    Domain
    
    Enum
    
    Make
    
    S
    
    Exn
    
    Fn
    
    Let
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Lift
    
    List
    
    Monad_infix
    
    Name
    
    Object
    
    S
    
    Order
    
    S
    
    Pair
    
    Persistent
    
    Rule
    
    Seq
    
    Slot
    
    Symbol
    
    Syntax
    
    Triple
    
    Value
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

Creates a new enumerated type.

Parameters

Signature

type t

declare ?package name declares a new element of the enumeration.

Fails if the name is already declared.

val declare : ?package:string -> string -> t

declare ?package name declares a new element of the enumeration.

Fails if the name is already declared.

val read : ?package:string -> string -> t

read ?package name reads the element from its textual representation.

Fails if the name doesn't represent a previously declared element of the enumeration.

If name is unqualified then package is used as the package name. The package itself defaults to "user".

See also of_string s from the Stringable interface which is equal to read s

val name : t -> Name.t

name x is the name that corresponds to the element x

val unknown : t

unknown is the placeholder for unknown element.

val is_unknown : t -> bool

is_unknown t is true if t is unknown.

val domain : t domain

domain the type class implementing the domain structure.

Each enumeration type forms a flat domain with the unknown element at the bottom.

val persistent : t persistent

persistent the persistance type class.

The enumeration types are persistent and are derived from the KB.Name.persistent type class, i.e., they are represented as 63-bit numbers.

val hash : t -> int

the hash value of the enum

val members : unit -> t list

members () the list of all members of the enumeration type.

include Base.Comparable.S with type t := t

val (>=) : t -> t -> bool

val (<=) : t -> t -> bool

val (=) : t -> t -> bool

val (>) : t -> t -> bool

val (<) : t -> t -> bool

val (<>) : t -> t -> bool

val equal : t -> t -> bool

val compare : t -> t -> int

val min : t -> t -> t

val max : t -> t -> t

val ascending : t -> t -> int

val descending : t -> t -> int

val between : t -> low:t -> high:t -> bool

val clamp_exn : t -> min:t -> max:t -> t

val clamp : t -> min:t -> max:t -> t Base__.Or_error.t

type comparator_witness

val comparator : (t, comparator_witness) Base__Comparator.comparator

val validate_lbound : min:t Base__.Maybe_bound.t -> t Base__.Validate.check

val validate_ubound : max:t Base__.Maybe_bound.t -> t Base__.Validate.check

val validate_bound : 
  min:t Base__.Maybe_bound.t ->
  max:t Base__.Maybe_bound.t ->
  t Base__.Validate.check

include Core_kernel.Binable.S with type t := t

val bin_size_t : t Bin_prot.Size.sizer

val bin_write_t : t Bin_prot.Write.writer

val bin_read_t : t Bin_prot.Read.reader

val __bin_read_t__ : (int -> t) Bin_prot.Read.reader

val bin_shape_t : Bin_prot.Shape.t

val bin_writer_t : t Bin_prot.Type_class.writer

val bin_reader_t : t Bin_prot.Type_class.reader

val bin_t : t Bin_prot.Type_class.t

include Core_kernel.Stringable.S with type t := t

val of_string : string -> t

val to_string : t -> string

include Core_kernel.Pretty_printer.S with type t := t

val pp : Base__.Formatter.t -> t -> unit

include Core_kernel.Sexpable.S with type t := t

val t_of_sexp : Sexplib0__.Sexp.t -> t

val sexp_of_t : t -> Sexplib0__.Sexp.t