package catala

You can search for identifiers within the package.

in-package search v0.2.0

catala.catala_utils
- Catala_utils
  - Cli
    
    Flags
    
    Global
  - File
    
    Map
    
    Tree
  - Global
  - Map
    
    Make
    
    Ord
    
    OrderedType
    
    S
  - Mark
    
    marked_iter
    
    marked_map
    
    pos_iter
    
    pos_map
  - Message
    
    Content
  - Pos
  - String
    
    Map
  - Suggestions
  - Uid
    
    Gen
    
    Map
    
    _
    
    Gen_qualified
    
    Map
    
    _
    
    Id
    
    Map
    
    Info
    
    Make
    
    Map
    
    X
    
    _
    
    MarkedString
    
    Module
    
    Map
    
    Path
    
    Style
  - Version
catala.clerk_driver
- Clerk_driver
catala.dcalc
- Dcalc
catala.desugared
- Desugared
  - Ast
    
    AssertionName
    
    Map
    
    ExprMap
    
    ScopeDef
    
    Map
  - Dependency
    
    ExceptionVertex
    
    Vertex
  - Disambiguate
  - From_surface
  - Linting
  - Name_resolution
  - Print
catala.driver
- Driver
  - Commands
  - Passes
  - Plugin
catala.lcalc
- Lcalc
catala.literate
- Literate
  - Html
  - Latex
  - Literate_common
  - Pygment_lexers
    
    Internal
  - Pygmentize
catala.plugins.api_web
- Api_web
  - To_jsoo
catala.plugins.explain
- Explain
  - E
  - Env
  - G
    
    E
    
    V
  - GTopo
  - V
catala.plugins.json_schema
- Json_schema
  - To_json
catala.plugins.lazy-interpreter
- Lazy_interpreter
  - Lazy_interp
    
    Env
catala.plugins.python
- Python
catala.runtime_jsoo
- Runtime_jsoo
  - Runtime
    
    duration
    
    event
    
    event_manager
    
    raw_event
    
    source_position
catala.runtime_ocaml
- Runtime_ocaml
  - Runtime
    
    Eoption
    
    EventParser
    
    Json
    
    Oper
catala.scalc
- Scalc
  - Ast
    
    FuncName
    
    Map
    
    Set
    
    VarName
    
    Map
    
    Set
  - From_lcalc
  - Print
  - To_c
  - To_python
  - To_r
catala.scopelang
- Scopelang
  - Ast
  - Dependency
    
    TVertex
  - From_desugared
  - Print
catala.shared_ast
- Shared_ast
  - BoundList
  - EnumConstructor
    
    Map
    
    Set
  - EnumName
    
    Map
    
    Set
  - Expr
    
    Box
  - Interpreter
  - LabelName
    
    Map
    
    Set
  - Op
  - Operator
  - Optimizations
  - Print
    
    EXPR_PARAM
    
    ExprConciseParam
    
    ExprDebugParam
    
    ExprGen
    
    _
    
    UserFacing
  - Program
  - Qident
  - RuleName
    
    Map
    
    Set
  - Scope
  - ScopeName
    
    Map
    
    Set
  - ScopeVar
    
    Map
    
    Set
  - StateName
    
    Map
    
    Set
  - StructField
    
    Map
    
    Set
  - StructName
    
    Map
    
    Set
  - TopdefName
    
    Map
    
    Set
  - Type
    
    Map
  - Typing
    
    Env
  - Var
    
    Map
    
    Set
catala.surface
- Surface
  - Ast
    
    map
  - Fill_positions
  - Lexer_common
    
    LocalisedLexer
  - Lexer_en
  - Lexer_fr
  - Lexer_pl
  - Parser
    
    Make
    
    Incremental
    
    Localisation
    
    MenhirInterpreter
  - Parser_driver
  - Parser_errors
  - Print
  - Tokens
catala.verification
- Verification
  - Conditions
  - Globals
  - Io
    
    Backend
    
    BackendIO
    
    MakeBackendIO
    
    B
  - Solver
  - Z3backend
    
    Io

Legend:
Library
Module
Module type
Parameter
Class
Class type

Reference interpreter for the default calculus

val evaluate_operator : 
  (((< < monomorphic : Shared_ast__.Definitions.yes
       ; polymorphic : Shared_ast__.Definitions.yes
       ; overloaded : Shared_ast__.Definitions.no
       ; resolved : Shared_ast__.Definitions.yes
       ; syntacticNames : Shared_ast__.Definitions.no
       ; scopeVarStates : Shared_ast__.Definitions.no
       ; scopeVarSimpl : Shared_ast__.Definitions.no
       ; explicitScopes : Shared_ast__.Definitions.no
       ; assertions : Shared_ast__.Definitions.yes >
      ; defaultTerms : _
      ; exceptions : _
      ; custom : _ > as 'a,
      < < monomorphic : Shared_ast__.Definitions.yes
        ; polymorphic : Shared_ast__.Definitions.yes
        ; overloaded : Shared_ast__.Definitions.no
        ; resolved : Shared_ast__.Definitions.yes
        ; syntacticNames : Shared_ast__.Definitions.no
        ; scopeVarStates : Shared_ast__.Definitions.no
        ; scopeVarSimpl : Shared_ast__.Definitions.no
        ; explicitScopes : Shared_ast__.Definitions.no
        ; assertions : Shared_ast__.Definitions.yes >
      ; defaultTerms : _
      ; exceptions : _
      ; custom : _ > as 'a,
      'm)
      Shared_ast__.Definitions.base_gexpr,
     'm Shared_ast__.Definitions.mark)
     Catala_utils.Mark.ed ->
    (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
      'm Shared_ast__.Definitions.mark)
      Catala_utils.Mark.ed) ->
  'a Shared_ast__.Definitions.Op.t Catala_utils.Mark.pos ->
  'm Shared_ast__.Definitions.mark ->
  Catala_utils.Global.backend_lang ->
  (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed
    list ->
  (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed

Evaluates the result of applying the given operator to the given arguments, which are expected to be already reduced to values. The first argument is used to evaluate expressions and called when reducing e.g. the map operator.

val evaluate_expr : 
  Shared_ast__.Definitions.decl_ctx ->
  Catala_utils.Global.backend_lang ->
  ((< < monomorphic : Shared_ast__.Definitions.yes
      ; polymorphic : Shared_ast__.Definitions.yes
      ; overloaded : Shared_ast__.Definitions.no
      ; resolved : Shared_ast__.Definitions.yes
      ; syntacticNames : Shared_ast__.Definitions.no
      ; scopeVarStates : Shared_ast__.Definitions.no
      ; scopeVarSimpl : Shared_ast__.Definitions.no
      ; explicitScopes : Shared_ast__.Definitions.no
      ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : _ >,
     < < monomorphic : Shared_ast__.Definitions.yes
       ; polymorphic : Shared_ast__.Definitions.yes
       ; overloaded : Shared_ast__.Definitions.no
       ; resolved : Shared_ast__.Definitions.yes
       ; syntacticNames : Shared_ast__.Definitions.no
       ; scopeVarStates : Shared_ast__.Definitions.no
       ; scopeVarSimpl : Shared_ast__.Definitions.no
       ; explicitScopes : Shared_ast__.Definitions.no
       ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : _ >,
     'm)
     Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed ->
  ((< < monomorphic : Shared_ast__.Definitions.yes
      ; polymorphic : Shared_ast__.Definitions.yes
      ; overloaded : Shared_ast__.Definitions.no
      ; resolved : Shared_ast__.Definitions.yes
      ; syntacticNames : Shared_ast__.Definitions.no
      ; scopeVarStates : Shared_ast__.Definitions.no
      ; scopeVarSimpl : Shared_ast__.Definitions.no
      ; explicitScopes : Shared_ast__.Definitions.no
      ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : Shared_ast__.Definitions.yes >,
     < < monomorphic : Shared_ast__.Definitions.yes
       ; polymorphic : Shared_ast__.Definitions.yes
       ; overloaded : Shared_ast__.Definitions.no
       ; resolved : Shared_ast__.Definitions.yes
       ; syntacticNames : Shared_ast__.Definitions.no
       ; scopeVarStates : Shared_ast__.Definitions.no
       ; scopeVarSimpl : Shared_ast__.Definitions.no
       ; explicitScopes : Shared_ast__.Definitions.no
       ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : Shared_ast__.Definitions.yes >,
     'm)
     Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed

Evaluates an expression according to the semantics of the default calculus.

val interpret_program_dcalc : 
  ((< monomorphic : Shared_ast__.Definitions.yes
     ; polymorphic : Shared_ast__.Definitions.yes
     ; overloaded : Shared_ast__.Definitions.no
     ; resolved : Shared_ast__.Definitions.yes
     ; syntacticNames : Shared_ast__.Definitions.no
     ; scopeVarStates : Shared_ast__.Definitions.no
     ; scopeVarSimpl : Shared_ast__.Definitions.no
     ; explicitScopes : Shared_ast__.Definitions.no
     ; assertions : Shared_ast__.Definitions.yes
     ; defaultTerms : Shared_ast__.Definitions.yes
     ; exceptions : Shared_ast__.Definitions.no
     ; custom : Shared_ast__.Definitions.no >,
     < monomorphic : Shared_ast__.Definitions.yes
     ; polymorphic : Shared_ast__.Definitions.yes
     ; overloaded : Shared_ast__.Definitions.no
     ; resolved : Shared_ast__.Definitions.yes
     ; syntacticNames : Shared_ast__.Definitions.no
     ; scopeVarStates : Shared_ast__.Definitions.no
     ; scopeVarSimpl : Shared_ast__.Definitions.no
     ; explicitScopes : Shared_ast__.Definitions.no
     ; assertions : Shared_ast__.Definitions.yes
     ; defaultTerms : Shared_ast__.Definitions.yes
     ; exceptions : Shared_ast__.Definitions.no
     ; custom : Shared_ast__.Definitions.no >,
     'm)
     Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed
    Shared_ast__.Definitions.program ->
  Shared_ast__.Definitions.ScopeName.t ->
  (Catala_utils.Uid.MarkedString.info
   * ((< < monomorphic : Shared_ast__.Definitions.yes
         ; polymorphic : Shared_ast__.Definitions.yes
         ; overloaded : Shared_ast__.Definitions.no
         ; resolved : Shared_ast__.Definitions.yes
         ; syntacticNames : Shared_ast__.Definitions.no
         ; scopeVarStates : Shared_ast__.Definitions.no
         ; scopeVarSimpl : Shared_ast__.Definitions.no
         ; explicitScopes : Shared_ast__.Definitions.no
         ; assertions : Shared_ast__.Definitions.yes >
        ; defaultTerms : Shared_ast__.Definitions.yes
        ; exceptions : Shared_ast__.Definitions.no
        ; custom : Shared_ast__.Definitions.yes >,
        < < monomorphic : Shared_ast__.Definitions.yes
          ; polymorphic : Shared_ast__.Definitions.yes
          ; overloaded : Shared_ast__.Definitions.no
          ; resolved : Shared_ast__.Definitions.yes
          ; syntacticNames : Shared_ast__.Definitions.no
          ; scopeVarStates : Shared_ast__.Definitions.no
          ; scopeVarSimpl : Shared_ast__.Definitions.no
          ; explicitScopes : Shared_ast__.Definitions.no
          ; assertions : Shared_ast__.Definitions.yes >
        ; defaultTerms : Shared_ast__.Definitions.yes
        ; exceptions : Shared_ast__.Definitions.no
        ; custom : Shared_ast__.Definitions.yes >,
        'm)
        Shared_ast__.Definitions.base_gexpr,
       'm Shared_ast__.Definitions.mark)
       Catala_utils.Mark.ed)
    list

Interprets a program. This function expects an expression typed as a function whose argument are all thunked. The function is executed by providing for each argument a thunked empty default. Returns a list of all the computed values for the scope variables of the executed scope.

val interpret_program_lcalc : 
  ((< monomorphic : Shared_ast__.Definitions.yes
     ; polymorphic : Shared_ast__.Definitions.yes
     ; overloaded : Shared_ast__.Definitions.no
     ; resolved : Shared_ast__.Definitions.yes
     ; syntacticNames : Shared_ast__.Definitions.no
     ; scopeVarStates : Shared_ast__.Definitions.no
     ; scopeVarSimpl : Shared_ast__.Definitions.no
     ; explicitScopes : Shared_ast__.Definitions.no
     ; assertions : Shared_ast__.Definitions.yes
     ; defaultTerms : Shared_ast__.Definitions.no
     ; exceptions : Shared_ast__.Definitions.yes
     ; custom : Shared_ast__.Definitions.no >,
     < monomorphic : Shared_ast__.Definitions.yes
     ; polymorphic : Shared_ast__.Definitions.yes
     ; overloaded : Shared_ast__.Definitions.no
     ; resolved : Shared_ast__.Definitions.yes
     ; syntacticNames : Shared_ast__.Definitions.no
     ; scopeVarStates : Shared_ast__.Definitions.no
     ; scopeVarSimpl : Shared_ast__.Definitions.no
     ; explicitScopes : Shared_ast__.Definitions.no
     ; assertions : Shared_ast__.Definitions.yes
     ; defaultTerms : Shared_ast__.Definitions.no
     ; exceptions : Shared_ast__.Definitions.yes
     ; custom : Shared_ast__.Definitions.no >,
     'm)
     Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed
    Shared_ast__.Definitions.program ->
  Shared_ast__.Definitions.ScopeName.t ->
  (Catala_utils.Uid.MarkedString.info
   * ((< < monomorphic : Shared_ast__.Definitions.yes
         ; polymorphic : Shared_ast__.Definitions.yes
         ; overloaded : Shared_ast__.Definitions.no
         ; resolved : Shared_ast__.Definitions.yes
         ; syntacticNames : Shared_ast__.Definitions.no
         ; scopeVarStates : Shared_ast__.Definitions.no
         ; scopeVarSimpl : Shared_ast__.Definitions.no
         ; explicitScopes : Shared_ast__.Definitions.no
         ; assertions : Shared_ast__.Definitions.yes >
        ; defaultTerms : Shared_ast__.Definitions.no
        ; exceptions : Shared_ast__.Definitions.yes
        ; custom : Shared_ast__.Definitions.yes >,
        < < monomorphic : Shared_ast__.Definitions.yes
          ; polymorphic : Shared_ast__.Definitions.yes
          ; overloaded : Shared_ast__.Definitions.no
          ; resolved : Shared_ast__.Definitions.yes
          ; syntacticNames : Shared_ast__.Definitions.no
          ; scopeVarStates : Shared_ast__.Definitions.no
          ; scopeVarSimpl : Shared_ast__.Definitions.no
          ; explicitScopes : Shared_ast__.Definitions.no
          ; assertions : Shared_ast__.Definitions.yes >
        ; defaultTerms : Shared_ast__.Definitions.no
        ; exceptions : Shared_ast__.Definitions.yes
        ; custom : Shared_ast__.Definitions.yes >,
        'm)
        Shared_ast__.Definitions.base_gexpr,
       'm Shared_ast__.Definitions.mark)
       Catala_utils.Mark.ed)
    list

val delcustom : 
  ((< < monomorphic : Shared_ast__.Definitions.yes
      ; polymorphic : Shared_ast__.Definitions.yes
      ; overloaded : Shared_ast__.Definitions.no
      ; resolved : Shared_ast__.Definitions.yes
      ; syntacticNames : Shared_ast__.Definitions.no
      ; scopeVarStates : Shared_ast__.Definitions.no
      ; scopeVarSimpl : Shared_ast__.Definitions.no
      ; explicitScopes : Shared_ast__.Definitions.no
      ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : 'c >,
     < < monomorphic : Shared_ast__.Definitions.yes
       ; polymorphic : Shared_ast__.Definitions.yes
       ; overloaded : Shared_ast__.Definitions.no
       ; resolved : Shared_ast__.Definitions.yes
       ; syntacticNames : Shared_ast__.Definitions.no
       ; scopeVarStates : Shared_ast__.Definitions.no
       ; scopeVarSimpl : Shared_ast__.Definitions.no
       ; explicitScopes : Shared_ast__.Definitions.no
       ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : 'c >,
     'm)
     Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed ->
  ((< < monomorphic : Shared_ast__.Definitions.yes
      ; polymorphic : Shared_ast__.Definitions.yes
      ; overloaded : Shared_ast__.Definitions.no
      ; resolved : Shared_ast__.Definitions.yes
      ; syntacticNames : Shared_ast__.Definitions.no
      ; scopeVarStates : Shared_ast__.Definitions.no
      ; scopeVarSimpl : Shared_ast__.Definitions.no
      ; explicitScopes : Shared_ast__.Definitions.no
      ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : Shared_ast__.Definitions.no >,
     < < monomorphic : Shared_ast__.Definitions.yes
       ; polymorphic : Shared_ast__.Definitions.yes
       ; overloaded : Shared_ast__.Definitions.no
       ; resolved : Shared_ast__.Definitions.yes
       ; syntacticNames : Shared_ast__.Definitions.no
       ; scopeVarStates : Shared_ast__.Definitions.no
       ; scopeVarSimpl : Shared_ast__.Definitions.no
       ; explicitScopes : Shared_ast__.Definitions.no
       ; assertions : Shared_ast__.Definitions.yes >
     ; defaultTerms : 'a
     ; exceptions : 'b
     ; custom : Shared_ast__.Definitions.no >,
     'm)
     Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed

Runtime check that the term contains no custom terms (raises Invalid_argument if that is the case

val load_runtime_modules : _ Shared_ast__.Definitions.program -> unit

Dynlink the runtime modules required by the given program, in order to make them callable by the interpreter.