Module `Runtime`Source

Types

Sourcetype money

Sourcetype integer

Sourcetype decimal

Sourcetype date

Sourcetype duration

Sourcetype source_position = {

filename : string;
start_line : int;
start_column : int;
end_line : int;
end_column : int;
law_headings : string list;

}

Exceptions

Sourceexception EmptyError

Sourceexception AssertionFailed

Sourceexception ConflictError

Sourceexception UncomparableDurations

Sourceexception IndivisableDurations

Sourceexception ImpossibleDate

Sourceexception NoValueProvided of source_position

Value Embedding

Sourcetype runtime_value =

| Unit
| Bool of bool
| Money of money
| Integer of integer
| Decimal of decimal
| Date of date
| Duration of duration
| Enum of string list * string * runtime_value
| Struct of string list * (string * runtime_value) list
| Array of runtime_value Array.t
| Unembeddable

Sourceval unembeddable : 'a -> runtime_value

Sourceval embed_unit : unit -> runtime_value

Sourceval embed_bool : bool -> runtime_value

Sourceval embed_money : money -> runtime_value

Sourceval embed_integer : integer -> runtime_value

Sourceval embed_decimal : decimal -> runtime_value

Sourceval embed_date : date -> runtime_value

Sourceval embed_duration : duration -> runtime_value

Sourceval embed_array : ('a -> runtime_value) -> 'a Array.t -> runtime_value

Logging

Sourcetype event =

| BeginCall of string list
| EndCall of string list
| VariableDefinition of string list * runtime_value
| DecisionTaken of source_position

Sourceval reset_log : unit -> unit

Sourceval retrieve_log : unit -> event list

Sourceval log_begin_call : string list -> ('a -> 'b) -> 'a -> 'b

Sourceval log_end_call : string list -> 'a -> 'a

Sourceval log_variable_definition : string list -> ('a -> runtime_value) -> 'a -> 'a

Sourceval log_decision_taken : source_position -> bool -> bool

Constructors and conversions

Money

Sourceval money_of_cents_string : string -> money

Sourceval money_of_units_int : int -> money

Sourceval money_of_cents_integer : integer -> money

Sourceval money_to_float : money -> float

Sourceval money_to_string : money -> string

Sourceval money_to_cents : money -> integer

Decimals

Sourceval decimal_of_string : string -> decimal

Sourceval decimal_to_string : max_prec_digits:int -> decimal -> string

Sourceval decimal_of_integer : integer -> decimal

Sourceval decimal_of_float : float -> decimal

Sourceval decimal_to_float : decimal -> float

Integers

Sourceval integer_of_string : string -> integer

Sourceval integer_to_string : integer -> string

Sourceval integer_to_int : integer -> int

Sourceval integer_of_int : int -> integer

Sourceval integer_log2 : integer -> int

Sourceval integer_exponentiation : integer -> int -> integer

Dates

Sourceval day_of_month_of_date : date -> integer

Sourceval month_number_of_date : date -> integer

Sourceval year_of_date : date -> integer

Sourceval date_to_string : date -> string

Sourceval date_of_numbers : int -> int -> int -> date

Usage: date_of_numbers year month day

raises ImpossibleDate

Durations

Sourceval duration_of_numbers : int -> int -> int -> duration

Sourceval duration_to_years_months_days : duration -> int * int * int

Sourceval duration_to_string : duration -> string

Defaults

Sourceval handle_default : (unit -> 'a) array -> (unit -> bool) -> (unit -> 'a) -> 'a

raises EmptyError

raises ConflictError

Sourceval no_input : unit -> 'a

Operators

Money

Sourceval (*$) : money -> decimal -> money

Sourceval (/$) : money -> money -> decimal

raises Division_by_zero

Sourceval (+$) : money -> money -> money

Sourceval (-$) : money -> money -> money

Sourceval (~-$) : money -> money

Sourceval (=$) : money -> money -> bool

Sourceval (<=$) : money -> money -> bool

Sourceval (>=$) : money -> money -> bool

Sourceval (<$) : money -> money -> bool

Sourceval (>$) : money -> money -> bool

Integers

Sourceval (+!) : integer -> integer -> integer

Sourceval (-!) : integer -> integer -> integer

Sourceval (~-!) : integer -> integer

Sourceval (*!) : integer -> integer -> integer

Sourceval (/!) : integer -> integer -> integer

raises Division_by_zero

Sourceval (=!) : integer -> integer -> bool

Sourceval (>=!) : integer -> integer -> bool

Sourceval (<=!) : integer -> integer -> bool

Sourceval (>!) : integer -> integer -> bool

Sourceval (<!) : integer -> integer -> bool

Decimals

Sourceval (+&) : decimal -> decimal -> decimal

Sourceval (-&) : decimal -> decimal -> decimal

Sourceval (~-&) : decimal -> decimal

Sourceval (*&) : decimal -> decimal -> decimal

Sourceval (/&) : decimal -> decimal -> decimal

raises Division_by_zero

Sourceval (=&) : decimal -> decimal -> bool

Sourceval (>=&) : decimal -> decimal -> bool

Sourceval (<=&) : decimal -> decimal -> bool

Sourceval (>&) : decimal -> decimal -> bool

Sourceval (<&) : decimal -> decimal -> bool

Dates

Sourceval (+@) : date -> duration -> date

Sourceval (-@) : date -> date -> duration

Sourceval (=@) : date -> date -> bool

Sourceval (>=@) : date -> date -> bool

Sourceval (<=@) : date -> date -> bool

Sourceval (>@) : date -> date -> bool

Sourceval (<@) : date -> date -> bool

Durations

Sourceval (+^) : duration -> duration -> duration

Sourceval (-^) : duration -> duration -> duration

Sourceval (/^) : duration -> duration -> decimal

raises Division_by_zero

raises IndivisableDurations

Sourceval (~-^) : duration -> duration

Sourceval (=^) : duration -> duration -> bool

Sourceval (>=^) : duration -> duration -> bool

raises UncomparableDurations

Sourceval (<=^) : duration -> duration -> bool

raises UncomparableDurations

Sourceval (>^) : duration -> duration -> bool

raises UncomparableDurations

Sourceval (<^) : duration -> duration -> bool

raises UncomparableDurations

Arrays

Sourceval array_filter : ('a -> bool) -> 'a array -> 'a array

Sourceval array_length : 'a array -> integer

Install

Dune Dependency

Authors

Maintainers

Sources

doc/catala.runtime/Runtime/index.html

Module `Runtime`Source

Types

Exceptions

Value Embedding

Logging

Constructors and conversions

Money

Decimals

Integers

Dates

Durations

Defaults

Operators

Money

Integers

Decimals

Dates

Durations

Arrays

package catala

Install

Dune Dependency

Authors

Maintainers

Sources

doc/catala.runtime/Runtime/index.html

Module RuntimeSource

Types

Exceptions

Value Embedding

Logging

Constructors and conversions

Money

Decimals

Integers

Dates

Durations

Defaults

Operators

Money

Integers

Decimals

Dates

Durations

Arrays

Module `Runtime`Source