Chapter 6  The OCaml language

7  Expressions

• Basic expressions
• Control structures
• Operations on data structures
• Operators
• Objects
• Coercions
• Other

The table below shows the relative precedences and associativity of operators and non-closed constructions. The constructions with higher precedence come first. For infix and prefix symbols, we write “*…” to mean “any symbol starting with *”.

7.1  Basic expressions

Constants

An expression consisting in a constant evaluates to this constant.

Value paths

An expression consisting in an access path evaluates to the value bound to this path in the current evaluation environment. The path can be either a value name or an access path to a value component of a module.

Parenthesized expressions

The expressions ( expr ) and begin expr end have the same value as expr. The two constructs are semantically equivalent, but it is good style to use begin … end inside control structures:

        if … then begin … ; … end else begin … ; … end

and ( … ) for the other grouping situations.

Parenthesized expressions can contain a type constraint, as in ( expr :  typexpr ). This constraint forces the type of expr to be compatible with typexpr.

Parenthesized expressions can also contain coercions ( expr  [: typexpr] :>  typexpr) (see subsection 6.7.6 below).

Function application

Function application is denoted by juxtaposition of (possibly labeled) expressions. The expression expr  argument₁ …  argument_n evaluates the expression expr and those appearing in argument₁ to argument_n. The expression expr must evaluate to a functional value f, which is then applied to the values of argument₁, …,  argument_n.

The order in which the expressions expr,  argument₁, …,  argument_n are evaluated is not specified.

Arguments and parameters are matched according to their respective labels. Argument order is irrelevant, except among arguments with the same label, or no label.

If a parameter is specified as optional (label prefixed by ?) in the type of expr, the corresponding argument will be automatically wrapped with the constructor Some, except if the argument itself is also prefixed by ?, in which case it is passed as is. If a non-labeled argument is passed, and its corresponding parameter is preceded by one or several optional parameters, then these parameters are defaulted, i.e. the value None will be passed for them. All other missing parameters (without corresponding argument), both optional and non-optional, will be kept, and the result of the function will still be a function of these missing parameters to the body of f.

As a special case, if the function has a known arity, all the arguments are unlabeled, and their number matches the number of non-optional parameters, then labels are ignored and non-optional parameters are matched in their definition order. Optional arguments are defaulted.

In all cases but exact match of order and labels, without optional parameters, the function type should be known at the application point. This can be ensured by adding a type constraint. Principality of the derivation can be checked in the -principal mode.

Function definition

Two syntactic forms are provided to define functions. The first form is introduced by the keyword function:

This expression evaluates to a functional value with one argument. When this function is applied to a value v, this value is matched against each pattern pattern₁ to pattern_n. If one of these matchings succeeds, that is, if the value v matches the pattern pattern_i for some i, then the expression expr_i associated to the selected pattern is evaluated, and its value becomes the value of the function application. The evaluation of expr_i takes place in an environment enriched by the bindings performed during the matching.

If several patterns match the argument v, the one that occurs first in the function definition is selected. If none of the patterns matches the argument, the exception Match_failure is raised.

The other form of function definition is introduced by the keyword fun:

This expression is equivalent to:

An optional type constraint typexpr can be added before -> to enforce the type of the result to be compatible with the constraint typexpr:

is equivalent to

Beware of the small syntactic difference between a type constraint on the last parameter

and one on the result

The parameter patterns ~lab and ~(lab  [: typ]) are shorthands for respectively ~lab: lab and ~lab:( lab  [: typ]), and similarly for their optional counterparts.

A function of the form fun ? lab :(  pattern =  expr₀ ) ->  expr is equivalent to

where ident is a fresh variable, except that it is unspecified when expr₀ is evaluated.

After these two transformations, expressions are of the form

If we ignore labels, which will only be meaningful at function application, this is equivalent to

That is, the fun expression above evaluates to a curried function with n arguments: after applying this function n times to the values v₁ … v_n, the values will be matched in parallel against the patterns pattern₁ …  pattern_n. If the matching succeeds, the function returns the value of expr in an environment enriched by the bindings performed during the matchings. If the matching fails, the exception Match_failure is raised.

Guards in pattern-matchings

The cases of a pattern matching (in the function, match and try constructs) can include guard expressions, which are arbitrary boolean expressions that must evaluate to true for the match case to be selected. Guards occur just before the -> token and are introduced by the when keyword:

Matching proceeds as described before, except that if the value matches some pattern pattern_i which has a guard cond_i, then the expression cond_i is evaluated (in an environment enriched by the bindings performed during matching). If cond_i evaluates to true, then expr_i is evaluated and its value returned as the result of the matching, as usual. But if cond_i evaluates to false, the matching is resumed against the patterns following pattern_i.

Local definitions

The let and let rec constructs bind value names locally. The construct

evaluates expr₁ …  expr_n in some unspecified order and matches their values against the patterns pattern₁ …  pattern_n. If the matchings succeed, expr is evaluated in the environment enriched by the bindings performed during matching, and the value of expr is returned as the value of the whole let expression. If one of the matchings fails, the exception Match_failure is raised.

An alternate syntax is provided to bind variables to functional values: instead of writing

in a let expression, one may instead write

Recursive definitions of names are introduced by let rec:

The only difference with the let construct described above is that the bindings of names to values performed by the pattern-matching are considered already performed when the expressions expr₁ to expr_n are evaluated. That is, the expressions expr₁ to expr_n can reference identifiers that are bound by one of the patterns pattern₁, …,  pattern_n, and expect them to have the same value as in expr, the body of the let rec construct.

The recursive definition is guaranteed to behave as described above if the expressions expr₁ to expr_n are function definitions (fun … or function …), and the patterns pattern₁ …  pattern_n are just value names, as in:

This defines name₁ …  name_n as mutually recursive functions local to expr.

The behavior of other forms of let rec definitions is implementation-dependent. The current implementation also supports a certain class of recursive definitions of non-functional values, as explained in section 7.2.

7.2  Control structures

Sequence

The expression expr₁ ;  expr₂ evaluates expr₁ first, then expr₂, and returns the value of expr₂.

Conditional

The expression if expr₁ then  expr₂ else  expr₃ evaluates to the value of expr₂ if expr₁ evaluates to the boolean true, and to the value of expr₃ if expr₁ evaluates to the boolean false.

The else expr₃ part can be omitted, in which case it defaults to else ().

Case expression

The expression

matches the value of expr against the patterns pattern₁ to pattern_n. If the matching against pattern_i succeeds, the associated expression expr_i is evaluated, and its value becomes the value of the whole match expression. The evaluation of expr_i takes place in an environment enriched by the bindings performed during matching. If several patterns match the value of expr, the one that occurs first in the match expression is selected. If none of the patterns match the value of expr, the exception Match_failure is raised.

Boolean operators

The expression expr₁ &&  expr₂ evaluates to true if both expr₁ and expr₂ evaluate to true; otherwise, it evaluates to false. The first component, expr₁, is evaluated first. The second component, expr₂, is not evaluated if the first component evaluates to false. Hence, the expression expr₁ &&  expr₂ behaves exactly as

The expression expr₁ ||  expr₂ evaluates to true if one of the expressions expr₁ and expr₂ evaluates to true; otherwise, it evaluates to false. The first component, expr₁, is evaluated first. The second component, expr₂, is not evaluated if the first component evaluates to true. Hence, the expression expr₁ ||  expr₂ behaves exactly as

The boolean operators & and or are deprecated synonyms for (respectively) && and ||.

Loops

The expression while expr₁ do  expr₂ done repeatedly evaluates expr₂ while expr₁ evaluates to true. The loop condition expr₁ is evaluated and tested at the beginning of each iteration. The whole while … done expression evaluates to the unit value ().

The expression for name =  expr₁ to  expr₂ do  expr₃ done first evaluates the expressions expr₁ and expr₂ (the boundaries) into integer values n and p. Then, the loop body expr₃ is repeatedly evaluated in an environment where name is successively bound to the values n, n+1, …, p−1, p. The loop body is never evaluated if n > p.

The expression for name =  expr₁ downto  expr₂ do  expr₃ done evaluates similarly, except that name is successively bound to the values n, n−1, …, p+1, p. The loop body is never evaluated if n < p.

In both cases, the whole for expression evaluates to the unit value ().

Exception handling

The expression

evaluates the expression expr and returns its value if the evaluation of expr does not raise any exception. If the evaluation of expr raises an exception, the exception value is matched against the patterns pattern₁ to pattern_n. If the matching against pattern_i succeeds, the associated expression expr_i is evaluated, and its value becomes the value of the whole try expression. The evaluation of expr_i takes place in an environment enriched by the bindings performed during matching. If several patterns match the value of expr, the one that occurs first in the try expression is selected. If none of the patterns matches the value of expr, the exception value is raised again, thereby transparently “passing through” the try construct.

7.3  Operations on data structures

Products

The expression expr₁ , … ,  expr_n evaluates to the n-tuple of the values of expressions expr₁ to expr_n. The evaluation order of the subexpressions is not specified.

Variants

The expression constr  expr evaluates to the unary variant value whose constructor is constr, and whose argument is the value of expr. Similarly, the expression constr (  expr₁ , … ,  expr_n ) evaluates to the n-ary variant value whose constructor is constr and whose arguments are the values of expr₁, …,  expr_n.

The expression constr ( expr₁, …,  expr_n) evaluates to the variant value whose constructor is constr, and whose arguments are the values of expr₁ …  expr_n.

For lists, some syntactic sugar is provided. The expression expr₁ ::  expr₂ stands for the constructor ( :: ) applied to the arguments ( expr₁ ,  expr₂ ), and therefore evaluates to the list whose head is the value of expr₁ and whose tail is the value of expr₂. The expression [ expr₁ ; … ;  expr_n ] is equivalent to expr₁ :: … ::  expr_n :: [], and therefore evaluates to the list whose elements are the values of expr₁ to expr_n.

Polymorphic variants

The expression `tag-name  expr evaluates to the polymorphic variant value whose tag is tag-name, and whose argument is the value of expr.

Records

The expression { field₁ =  expr₁ ; … ;  field_n =  expr_n } evaluates to the record value { field₁ = v₁; …; field_n = v_n } where v_i is the value of expr_i for i = 1,… , n. The fields field₁ to field_n must all belong to the same record type; each field of this record type must appear exactly once in the record expression, though they can appear in any order. The order in which expr₁ to expr_n are evaluated is not specified. Optional type constraints can be added after each field { field₁ :  typexpr₁ =  expr₁ ;… ;  field_n :  typexpr_n =  expr_n } to force the type of field_k to be compatible with typexpr_k.

The expression { expr with  field₁ =  expr₁ ; … ;  field_n =  expr_n } builds a fresh record with fields field₁ …  field_n equal to expr₁ …  expr_n, and all other fields having the same value as in the record expr. In other terms, it returns a shallow copy of the record expr, except for the fields field₁ …  field_n, which are initialized to expr₁ …  expr_n. As previously, it is possible to add an optional type constraint on each field being updated with { expr with  field₁ :  typexpr₁ =  expr₁ ; … ;  field_n :  typexpr_n =  expr_n }.

The expression expr₁ .  field evaluates expr₁ to a record value, and returns the value associated to field in this record value.

The expression expr₁ .  field <-  expr₂ evaluates expr₁ to a record value, which is then modified in-place by replacing the value associated to field in this record by the value of expr₂. This operation is permitted only if field has been declared mutable in the definition of the record type. The whole expression expr₁ .  field <-  expr₂ evaluates to the unit value ().

Arrays

The expression [| expr₁ ; … ;  expr_n |] evaluates to a n-element array, whose elements are initialized with the values of expr₁ to expr_n respectively. The order in which these expressions are evaluated is unspecified.

The expression expr₁ .(  expr₂ ) returns the value of element number expr₂ in the array denoted by expr₁. The first element has number 0; the last element has number n−1, where n is the size of the array. The exception Invalid_argument is raised if the access is out of bounds.

The expression expr₁ .(  expr₂ ) <-  expr₃ modifies in-place the array denoted by expr₁, replacing element number expr₂ by the value of expr₃. The exception Invalid_argument is raised if the access is out of bounds. The value of the whole expression is ().

Strings

The expression expr₁ .[  expr₂ ] returns the value of character number expr₂ in the string denoted by expr₁. The first character has number 0; the last character has number n−1, where n is the length of the string. The exception Invalid_argument is raised if the access is out of bounds.

The expression expr₁ .[  expr₂ ] <-  expr₃ modifies in-place the string denoted by expr₁, replacing character number expr₂ by the value of expr₃. The exception Invalid_argument is raised if the access is out of bounds. The value of the whole expression is ().

Note: this possibility is offered only for backward compatibility with older versions of OCaml and will be removed in a future version. New code should use byte sequences and the Bytes.set function.

7.4  Operators

Symbols from the class infix-symbol, as well as the keywords *, +, -, -., =, !=, <, >, or, ||, &, &&, :=, mod, land, lor, lxor, lsl, lsr, and asr can appear in infix position (between two expressions). Symbols from the class prefix-symbol, as well as the keywords - and -. can appear in prefix position (in front of an expression).

Infix and prefix symbols do not have a fixed meaning: they are simply interpreted as applications of functions bound to the names corresponding to the symbols. The expression prefix-symbol  expr is interpreted as the application ( prefix-symbol )  expr. Similarly, the expression expr₁  infix-symbol  expr₂ is interpreted as the application ( infix-symbol )  expr₁  expr₂.

The table below lists the symbols defined in the initial environment and their initial meaning. (See the description of the core library module Pervasives in chapter 22 for more details). Their meaning may be changed at any time using let ( infix-op )  name₁  name₂ = …

Note: the operators &&, ||, and ~- are handled specially and it is not advisable to change their meaning.

The keywords - and -. can appear both as infix and prefix operators. When they appear as prefix operators, they are interpreted respectively as the functions (~-) and (~-.).

7.5  Objects

Object creation

When class-path evaluates to a class body, new class-path evaluates to a new object containing the instance variables and methods of this class.

When class-path evaluates to a class function, new class-path evaluates to a function expecting the same number of arguments and returning a new object of this class.

Immediate object creation

Creating directly an object through the object class-body end construct is operationally equivalent to defining locally a class class-name = object  class-body end —see sections 6.9.2 and following for the syntax of class-body— and immediately creating a single object from it by new class-name.

The typing of immediate objects is slightly different from explicitly defining a class in two respects. First, the inferred object type may contain free type variables. Second, since the class body of an immediate object will never be extended, its self type can be unified with a closed object type.

Method invocation

The expression expr #  method-name invokes the method method-name of the object denoted by expr.

If method-name is a polymorphic method, its type should be known at the invocation site. This is true for instance if expr is the name of a fresh object (let ident = new  class-path … ) or if there is a type constraint. Principality of the derivation can be checked in the -principal mode.

Accessing and modifying instance variables

The instance variables of a class are visible only in the body of the methods defined in the same class or a class that inherits from the class defining the instance variables. The expression inst-var-name evaluates to the value of the given instance variable. The expression inst-var-name <-  expr assigns the value of expr to the instance variable inst-var-name, which must be mutable. The whole expression inst-var-name <-  expr evaluates to ().

Object duplication

An object can be duplicated using the library function Oo.copy (see Module Oo). Inside a method, the expression {< inst-var-name =  expr  { ; inst-var-name =  expr } >} returns a copy of self with the given instance variables replaced by the values of the associated expressions; other instance variables have the same value in the returned object as in self.

7.6  Coercions

Expressions whose type contains object or polymorphic variant types can be explicitly coerced (weakened) to a supertype. The expression (expr :>  typexpr) coerces the expression expr to type typexpr. The expression (expr :  typexpr₁ :>  typexpr₂) coerces the expression expr from type typexpr₁ to type typexpr₂.

The former operator will sometimes fail to coerce an expression expr from a type typ₁ to a type typ₂ even if type typ₁ is a subtype of type typ₂: in the current implementation it only expands two levels of type abbreviations containing objects and/or polymorphic variants, keeping only recursion when it is explicit in the class type (for objects). As an exception to the above algorithm, if both the inferred type of expr and typ are ground (i.e. do not contain type variables), the former operator behaves as the latter one, taking the inferred type of expr as typ₁. In case of failure with the former operator, the latter one should be used.

It is only possible to coerce an expression expr from type typ₁ to type typ₂, if the type of expr is an instance of typ₁ (like for a type annotation), and typ₁ is a subtype of typ₂. The type of the coerced expression is an instance of typ₂. If the types contain variables, they may be instantiated by the subtyping algorithm, but this is only done after determining whether typ₁ is a potential subtype of typ₂. This means that typing may fail during this latter unification step, even if some instance of typ₁ is a subtype of some instance of typ₂. In the following paragraphs we describe the subtyping relation used.

Object types

A fixed object type admits as subtype any object type that includes all its methods. The types of the methods shall be subtypes of those in the supertype. Namely,

is a supertype of

which may contain an ellipsis .. if every typ_i is a supertype of the corresponding typ′_i.

A monomorphic method type can be a supertype of a polymorphic method type. Namely, if typ is an instance of typ′, then 'a₁ … 'a_n . typ′ is a subtype of typ.

Inside a class definition, newly defined types are not available for subtyping, as the type abbreviations are not yet completely defined. There is an exception for coercing self to the (exact) type of its class: this is allowed if the type of self does not appear in a contravariant position in the class type, i.e. if there are no binary methods.

Polymorphic variant types

A polymorphic variant type typ is a subtype of another polymorphic variant type typ′ if the upper bound of typ (i.e. the maximum set of constructors that may appear in an instance of typ) is included in the lower bound of typ′, and the types of arguments for the constructors of typ are subtypes of those in typ′. Namely,

which may be a shrinkable type, is a subtype of

which may be an extensible type, if every typ_i is a subtype of typ′_i.

Variance

Other types do not introduce new subtyping, but they may propagate the subtyping of their arguments. For instance, typ₁ *  typ₂ is a subtype of typ′₁ * typ′₂ when typ₁ and typ₂ are respectively subtypes of typ′₁ and typ′₂. For function types, the relation is more subtle: typ₁ ->  typ₂ is a subtype of typ′₁ -> typ′₂ if typ₁ is a supertype of typ′₁ and typ₂ is a subtype of typ′₂. For this reason, function types are covariant in their second argument (like tuples), but contravariant in their first argument. Mutable types, like array or ref are neither covariant nor contravariant, they are nonvariant, that is they do not propagate subtyping.

For user-defined types, the variance is automatically inferred: a parameter is covariant if it has only covariant occurrences, contravariant if it has only contravariant occurrences, variance-free if it has no occurrences, and nonvariant otherwise. A variance-free parameter may change freely through subtyping, it does not have to be a subtype or a supertype. For abstract and private types, the variance must be given explicitly (see section 6.8.1), otherwise the default is nonvariant. This is also the case for constrained arguments in type definitions.

7.7  Other

Assertion checking

OCaml supports the assert construct to check debugging assertions. The expression assert expr evaluates the expression expr and returns () if expr evaluates to true. If it evaluates to false the exception Assert_failure is raised with the source file name and the location of expr as arguments. Assertion checking can be turned off with the -noassert compiler option. In this case, expr is not evaluated at all.

As a special case, assert false is reduced to raise (Assert_failure ...), which gives it a polymorphic type. This means that it can be used in place of any expression (for example as a branch of any pattern-matching). It also means that the assert false “assertions” cannot be turned off by the -noassert option.

Lazy expressions

The expression lazy expr returns a value v of type Lazy.t that encapsulates the computation of expr. The argument expr is not evaluated at this point in the program. Instead, its evaluation will be performed the first time the function Lazy.force is applied to the value v, returning the actual value of expr. Subsequent applications of Lazy.force to v do not evaluate expr again. Applications of Lazy.force may be implicit through pattern matching (see 7.3).

Local modules

The expression let module module-name =  module-expr in  expr locally binds the module expression module-expr to the identifier module-name during the evaluation of the expression expr. It then returns the value of expr. For example:

        let remove_duplicates comparison_fun string_list =
          let module StringSet =
            Set.Make(struct type t = string
                            let compare = comparison_fun end) in
          StringSet.elements
            (List.fold_right StringSet.add string_list StringSet.empty)