package ocamlformat

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Path sets

package ocamlformat

ocamlformat
- Ocamlformat
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Indexing_op
    
    Longident
    
    Mod
    
    Mty
    
    Pat
    
    String_id
    
    Token
    
    Tyd
  - Cmt
  - Cmts
    
    Toplevel
  - Conf
  - Config_option
    
    CONFIG
    
    Error
    
    Make
    
    C
    
    Value
    
    Value_removed
  - Docstring
  - Exposed
    
    Left
    
    Right
  - Extended_ast
    
    Asttypes
    
    Parse
    
    Printast
  - File_system
  - Fmt
  - Fmt_ast
  - Fmt_odoc
  - Indent
    
    Partial_ast
    
    Valid_ast
  - Literal_lexer
  - Loc_tree
  - Migrate_ast
    
    Lexing
    
    Location
    
    Longident
    
    Position
  - Multimap
    
    M
    
    K
  - Non_overlapping_interval_tree
    
    IN
    
    Make
    
    Itv
    
    S
  - Normalize_extended_ast
  - Normalize_std_ast
  - Params
    
    Exp
    
    Infix_op_arg
  - Parse_with_comments
    
    W
  - Prec
  - Range
  - Source
  - Std_ast
    
    Parse
    
    Printast
  - Sugar
    
    Exp
    
    Let_binding
  - Syntax
  - Toplevel_lexer
  - Translation_unit
    
    Error
  - Version
ocamlformat.format_
- Format_
ocamlformat.ocaml_common
- Ocaml_common
  - Location
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat.ocamlformat_stdlib
- Ocamlformat_stdlib
  - Cmdliner
  - Export
  - Fpath
    
    Map
    
    Set
  - List
  - Sexp
  - String
  - Warning
ocamlformat.parser_extended
- Parser_extended
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat.parser_recovery
- Parser_recovery
ocamlformat.parser_shims
- Parser_shims
  - Clflags
  - Int
  - List
  - Misc
    
    Color
    
    Error_style
    
    Int_literal_converter
    
    LongString
    
    Magic_number
    
    Stdlib
    
    Array
    
    List
    
    Option
    
    String
    
    Map
    
    Set
    
    Tbl
ocamlformat.parser_standard
- Parser_standard
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat.result
- Ocamlformat_result
  - Global_scope
  - Let_syntax
ocamlformat.rpc
- Ocamlformat_rpc
  - IO
  - Protocol
    
    Command_S
    
    Init
    
    V1
    
    V2
  - V
ocamlformat.rpc_lib_protocol
- Ocamlformat_rpc_lib_protocol
  - IO
    
    S
  - Protocol
    
    Make
    
    Command_S
    
    IO
    
    Init
    
    V1
    
    V2
    
    Version

Legend:
Library
Module
Module type
Parameter
Class
Class type

Path sets.

Path sets

include Set.S with type elt := path and type t := set

Sets

val empty : set

The empty set.

val add : path -> set -> set

add x s returns a set containing all elements of s, plus x. If x was already in s, s is returned unchanged (the result of the function is then physically equal to s).

before 4.03
Physical equality was not ensured.

val singleton : path -> set

singleton x returns the one-element set containing only x.

val remove : path -> set -> set

remove x s returns a set containing all elements of s, except x. If x was not in s, s is returned unchanged (the result of the function is then physically equal to s).

before 4.03
Physical equality was not ensured.

val union : set -> set -> set

Set union.

val inter : set -> set -> set

Set intersection.

val disjoint : set -> set -> bool

Test if two sets are disjoint.

since 4.08

val diff : set -> set -> set

Set difference: diff s1 s2 contains the elements of s1 that are not in s2.

val cardinal : set -> int

Return the number of elements of a set.

Elements

val elements : set -> path list

Return the list of all elements of the given set. The returned list is sorted in increasing order with respect to the ordering Ord.compare, where Ord is the argument given to Set.Make.

val min_elt_opt : set -> path option

Return the smallest element of the given set (with respect to the Ord.compare ordering), or None if the set is empty.

since 4.05

val max_elt_opt : set -> path option

Same as min_elt_opt, but returns the largest element of the given set.

since 4.05

val choose_opt : set -> path option

Return one element of the given set, or None if the set is empty. Which element is chosen is unspecified, but equal elements will be chosen for equal sets.

since 4.05

Searching

val find_opt : path -> set -> path option

find_opt x s returns the element of s equal to x (according to Ord.compare), or None if no such element exists.

since 4.05

val find_first : (path -> bool) -> set -> path

find_first f s, where f is a monotonically increasing function, returns the lowest element e of s such that f e, or raises Not_found if no such element exists.

For example, find_first (fun e -> Ord.compare e x >= 0) s will return the first element e of s where Ord.compare e x >= 0 (intuitively: e >= x), or raise Not_found if x is greater than any element of s.

since 4.05

val find_first_opt : (path -> bool) -> set -> path option

find_first_opt f s, where f is a monotonically increasing function, returns an option containing the lowest element e of s such that f e, or None if no such element exists.

since 4.05

val find_last : (path -> bool) -> set -> path

find_last f s, where f is a monotonically decreasing function, returns the highest element e of s such that f e, or raises Not_found if no such element exists.

since 4.05

val find_last_opt : (path -> bool) -> set -> path option

find_last_opt f s, where f is a monotonically decreasing function, returns an option containing the highest element e of s such that f e, or None if no such element exists.

since 4.05

Traversing

val iter : (path -> unit) -> set -> unit

iter f s applies f in turn to all elements of s. The elements of s are presented to f in increasing order with respect to the ordering over the type of the elements.

val fold : (path -> 'acc -> 'acc) -> set -> 'acc -> 'acc

fold f s init computes (f xN ... (f x2 (f x1 init))...), where x1 ... xN are the elements of s, in increasing order.

Transforming

val map : (path -> path) -> set -> set

map f s is the set whose elements are f a0,f a1... f aN, where a0,a1...aN are the elements of s.

The elements are passed to f in increasing order with respect to the ordering over the type of the elements.

If no element of s is changed by f, s is returned unchanged. (If each output of f is physically equal to its input, the returned set is physically equal to s.)

since 4.04

val filter : (path -> bool) -> set -> set

filter f s returns the set of all elements in s that satisfy predicate f. If f satisfies every element in s, s is returned unchanged (the result of the function is then physically equal to s).

before 4.03
Physical equality was not ensured.

val filter_map : (path -> path option) -> set -> set

filter_map f s returns the set of all v such that f x = Some v for some element x of s.

For example,

filter_map (fun n -> if n mod 2 = 0 then Some (n / 2) else None) s

is the set of halves of the even elements of s.

If no element of s is changed or dropped by f (if f x = Some x for each element x), then s is returned unchanged: the result of the function is then physically equal to s.

since 4.11

val partition : (path -> bool) -> set -> set * set

partition f s returns a pair of sets (s1, s2), where s1 is the set of all the elements of s that satisfy the predicate f, and s2 is the set of all the elements of s that do not satisfy f.

val split : path -> set -> set * bool * set

split x s returns a triple (l, present, r), where l is the set of elements of s that are strictly less than x; r is the set of elements of s that are strictly greater than x; present is false if s contains no element equal to x, or true if s contains an element equal to x.

Predicates and comparisons

val is_empty : set -> bool

Test whether a set is empty or not.

val mem : path -> set -> bool

mem x s tests whether x belongs to the set s.

val equal : set -> set -> bool

equal s1 s2 tests whether the sets s1 and s2 are equal, that is, contain equal elements.

val compare : set -> set -> int

Total ordering between sets. Can be used as the ordering function for doing sets of sets.

val subset : set -> set -> bool

subset s1 s2 tests whether the set s1 is a subset of the set s2.

val for_all : (path -> bool) -> set -> bool

for_all f s checks if all elements of the set satisfy the predicate f.

val exists : (path -> bool) -> set -> bool

exists f s checks if at least one element of the set satisfies the predicate f.

Converting

val to_list : set -> path list

to_list s is elements s.

since 5.1

val to_seq_from : path -> set -> path Seq.t

to_seq_from x s iterates on a subset of the elements of s in ascending order, from x or above.

since 4.07

val to_seq : set -> path Seq.t

Iterate on the whole set, in ascending order

since 4.07

val to_rev_seq : set -> path Seq.t

Iterate on the whole set, in descending order

since 4.12

val add_seq : path Seq.t -> set -> set

Add the given elements to the set, in order.

since 4.07

val of_seq : path Seq.t -> set

Build a set from the given bindings

since 4.07

type t = set

val min_elt : set -> path option

Exception safe Set.S.min_elt.

val get_min_elt : set -> path

get_min_let is like min_elt but

raises Invalid_argument
on the empty set.

val max_elt : set -> path option

Exception safe Set.S.max_elt.

val get_max_elt : set -> path

get_max_elt is like max_elt but

raises Invalid_argument
on the empty set.

val choose : set -> path option

Exception safe Set.S.choose.

val get_any_elt : set -> path

get_any_elt is like choose but

raises Invalid_argument
on the empty set.

val find : path -> set -> path option

Exception safe Set.S.find.

val get : path -> set -> path

get is like Set.S.find but

raises Invalid_argument
if elt is not in s.

val of_list : path list -> set

of_list ps is a set from the list ps.

val pp : 
  ?sep:(Format.formatter -> unit -> unit) ->
  (Format.formatter -> path -> unit) ->
  Format.formatter ->
  set ->
  unit

pp ~sep pp_elt ppf ps formats the elements of ps on ppf. Each element is formatted with pp_elt and elements are separated by ~sep (defaults to Format.pp_print_cut). If the set is empty leaves ppf untouched.

val dump : Format.formatter -> set -> unit

dump ppf ps prints an unspecified representation of ps on ppf.