# Index of modules

A
Arg [Batteries_uni] |
Arg [Batteries_uni.Legacy] |
Array [Batteries_uni] |
Array [Batteries_uni.Legacy] |
Array1 [BatBigarray] | One-dimensional arrays.
Array2 [BatBigarray] | Two-dimensional arrays.
Array3 [BatBigarray] | Three-dimensional arrays.
ArrayLabels [Batteries_uni.Legacy] |
B
Base64 [Batteries_uni] |
BatArg | Parsing of command line arguments.
BatArray | Additional and modified functions for arrays
BatAvlTree | Internals of ISet and IMap, usable as generic tree library
BatBase64 | Base64 codec.
BatBig_int | Operations on arbitrary-precision integers.
BatBigarray | Additional and modified functions for big arrays.
BatBitSet | Efficient bit sets.
BatBool | Operations on booleans
BatBuffer | Extensible string buffers.
BatCache | These functions build a cache with either a hashtbl or a map.
BatCamomile |
BatChar | Operations on characters.
BatCharEncodings | Character encodings.
BatCharParser | Parsing character strings.
BatComplex | Additional and modified functions for complex numbers.
BatConcurrent | Definition of concurrency primitives.
BatDeque | Functional double-ended queues
BatDigest | MD5 message digest.
BatDllist | A mutable, imperative, circular, doubly linked list library
BatDynArray | Dynamic arrays.
BatEnum | Enumeration over abstract collection of elements.
BatFile | File manipulation.
BatFloat | Operations on floating-point numbers.
BatFormat | Pretty printing.
BatGc | Memory management control and statistics; finalised values.
BatGenlex | A generic lexical analyzer.
BatGlobal | Mutable global variable.
BatHashcons | Hash consing of data structures
BatHashtbl | Extra functions over hashtables.
BatHeap | Functional heaps over ordered types
BatIMap | DIET Maps from integers, packed using ranges
BatIO | High-order abstract I/O.
BatISet | DIET Sets of integers represented as ranges
BatInnerIO | Core of the BatIO module.
BatInnerWeaktbl | Weak hash table library for OCaml, with an interface compatible with the standard Hashtbl module.
BatInt | Operations on integers.
BatInt32 | 32-bit integers.
BatInt64 | 64-bit integers.
BatInterfaces | Common signatures for data structures.
BatLazyList | Lazy lists of elements.
BatLexing | Simple lexing using ocaml conventions
BatList | Additional and modified functions for lists.
BatLogger | Logging Library
BatMap | Association tables over ordered types.
BatMarshal | Marshaling of data structures.
BatMonad | Definition of monads.
BatMultiPMap | Polymorphic Multi-Map.
BatMutex | Locks for mutual exclusion.
BatNativeint | Processor-native integers.
BatNum | Operation on arbitrary-precision numbers.
BatNumber | A common interface for numbers.
BatOo | Operations on objects
BatOptParse | Modules for GNU `getopt(3)`-style command line parsing.
BatOption | Functions for the option type.
BatPMap | Polymorphic Map.
BatPSet | Polymorphic sets
BatPair | Functions for pairs of values
BatParserCo | A simple parser combinator library.
BatPathGen | Filepath handling.
BatPervasives | Additional functions.
BatPrint | Formatted output functions (also known as unparsing).
BatPrintexc | Facilities for printing exceptions.
BatPrintf | Formatted output functions (also known as unparsing).
BatQueue | First-in first-out queues.
BatRMutex | Locks for mutual exclusion.
BatRandom | Pseudo-random number generators (PRNG).
BatRef | Operations on references.
BatRefList | Reference on lists.
BatResult | Monadic results of computations that can raise exceptions
BatReturn | Local exceptions/labels/goto/return.
BatRope | Heavyweight strings ("ropes")
BatScanf | Formatted input functions.
BatSeq | Sequence of elements
BatSet | Sets over ordered types.
BatSplay | Maps and sets based on splay trees
BatStack | Last-in first-out stacks.
BatStd | Additional functions.
BatStr | Regular expressions and high-level string processing
BatStream | Streams and stream parsers
BatString | String operations.
BatSubstring | `Substring.t` is the type of substrings of a basestring, an efficient representation of a piece of a string.
BatSys | System interface.
BatTuple | Tuples.
BatUChar | Unicode (ISO-UCS) characters.
BatUCharParser | Parsing unicode text
BatUTF8 | UTF-8 encoded Unicode strings.
BatUnit | Operations on `unit`.
BatUnix | Low-level interface to the operating system (both Unix and Windows).
BatUref | Unifiable references using destructive union-find
BatValue_printer | Value printers
BatVect | Extensible vectors with constant-time append/prepend.
Batteries |
Batteries_config [Batteries_uni] |
Batteries_config | This system's configuration.
Batteries_print |
Batteries_uni |
BigEndian [BatIO] | Same operations as module `BatIO`, but with big-endian encoding
Big_int [Batteries_uni] |
Bigarray [Batteries_uni] |
BitSet [Batteries_uni] |
Bit_set [Batteries_uni] |
Bool [Batteries_uni] |
Buf [BatUTF8] | Buffer module for UTF-8 strings
Buffer [Batteries_uni] |
Buffer [Batteries_uni.Legacy] |
Byte [BatUTF8] | Positions in the string represented by the number of bytes from the head.
C
C [BatGenlex.Languages.Library] |
Cache [Batteries_uni] |
Callback [Batteries_uni.Legacy] |
Cap [BatHashtbl] | Capabilities for hashtables.
Cap [BatArray] | Capabilities for arrays.
Char [Batteries_uni] |
Char [Batteries_uni.Legacy] |
CharParser [Batteries_uni] |
CharSet [BatSet] | A set of characters.
Compare [BatNum] |
Compare [BatNativeint] |
Compare [BatInt64] |
Compare [BatInt.Safe_int] |
Compare [BatInt] |
Compare [BatFloat] |
Compare [BatComplex] |
Compare [BatBool] |
Compare [BatBig_int] |
Complex [Batteries_uni] |
Complex [Batteries_uni.Legacy] |
Concurrent [Batteries_uni] |
D
Deque [Batteries_uni] |
Digest [Batteries_uni] |
Digest [Batteries_uni.Legacy] |
Dllist [Batteries_uni] |
DynArray [Batteries_uni] |
E
Enum [Batteries_uni] |
Exceptionless [BatStack] |
Exceptionless [BatSet.S] | Operations on `Set` without exceptions.
Exceptionless [BatSeq] |
Exceptionless [BatQueue] |
Exceptionless [BatPMap] |
Exceptionless [BatMap] | Exceptionless versions of functions
Exceptionless [BatMap.S] | Operations on `Map` without exceptions.
Exceptionless [BatList] | Exceptionless counterparts for error-raising operations
Exceptionless [BatLazyList.Labels] |
Exceptionless [BatLazyList] | Exceptionless counterparts for error-raising operations
Exceptionless [BatHashtbl.Cap] | Operations on `BatHashtbl.Cap` without exceptions.
Exceptionless [BatHashtbl.S] | Operations on `Hashtbl` without exceptions.
Exceptionless [BatHashtbl] | Operations on `Hashtbl` without exceptions.
Exceptionless [BatEnum] | Operations on `BatEnum` without exceptions.
Exceptionless [BatArray.Cap] | Operations on `BatArray.Cap` without exceptions.
Exceptionless [BatArray] | Operations on `Array` without exceptions.
F
File [Batteries_uni] |
Filename [Batteries_uni.Legacy] |
Float [Batteries_uni] |
Format [Batteries_uni] |
Format [Batteries_uni.Legacy] |
Formatter [BatOptParse] | This module contains the types and functions for implementing custom usage message formatters.
G
Gc [Batteries_uni] |
Gc [Batteries_uni.Legacy] |
Genarray [BatBigarray] | Generic arrays (of arbitrarily many dimensions)
Genlex [Batteries_uni] |
Genlex [Batteries_uni.Legacy] |
Global [Batteries_uni] |
H
H [BatHashcons] | Hashing utilities
Hashcons [Batteries_uni] |
Hashtbl [Batteries_uni] |
Hashtbl [Batteries_uni.Legacy] |
Heap [Batteries_uni] |
I
IMap [Batteries_uni] |
IO [Batteries_uni] |
IRope [BatRope] |
IRopeSet [BatSet] | A set of ropes.
ISet [Batteries_uni] |
IString [BatString] | uses icompare as ordering function
IStringMap [BatMap] | A map on strings.
IStringSet [BatSet] | A set of strings.
IUChar [BatUChar] |
Index [BatRefList] | Functions that operate on the element at index `i` in a list (with indices starting from 0).
Infix [BatRope] | Infix submodule regrouping all infix operators
Infix [BatResult] | Infix submodule regrouping all infix operators
Infix [BatPathGen.PathType] | As other Operators modules in batteries are named "Infix" we provide Infix as well.
Infix [BatParserCo] | Infix submodule regrouping all infix operators
Infix [BatPMap] |
Infix [BatNum] |
Infix [BatNativeint] |
Infix [BatMultiPMap] | Infix operators over a `BatMultiPMap`
Infix [BatMap] | Infix operators over a `BatPMap`
Infix [BatMap.S] | Infix operators over a `BatMap`
Infix [BatList] | Infix submodule regrouping all infix operators
Infix [BatLazyList] | Infix submodule regrouping all infix operators
Infix [BatInt64] |
Infix [BatInt.Safe_int] |
Infix [BatInt] |
Infix [BatIMap] | Infix operators over a `BatIMap`
Infix [BatHashtbl.S] | Infix operators over a `BatHashtbl`
Infix [BatHashtbl] | Infix operators over a `BatHashtbl`
Infix [BatFloat] |
Infix [BatEnum] |
Infix [BatComplex] |
Infix [BatChar] | Infix submodule regrouping all infix operators
Infix [BatBool] |
Infix [BatBig_int] |
Input [BatInnerIO] |
Int [Batteries_uni] |
Int32 [Batteries_uni] |
Int32 [Batteries_uni.Legacy] |
Int64 [Batteries_uni] |
Int64 [Batteries_uni.Legacy] |
IntMap [BatMap] | A map on integers.
IntSet [BatSet] | A set of integers.
Interfaces [Batteries_uni] |
Internal [BatOo.Oo] |
L
LExceptionless [BatList.Labels] |
LExceptionless [BatEnum.Labels] |
LExceptionless [BatArray.Labels] |
Labels [BatSet.S] | Operations on `Set` with labels.
Labels [BatOption] | Operations on options, with labels.
Labels [BatMap.S] | Operations on `Map` with labels.
Labels [BatList] | Operations on `List` with labels.
Labels [BatLazyList] | Operations on `LazyList` with labels.
Labels [BatHashtbl.Cap] | Operations on `BatHashtbl.Cap` with labels.
Labels [BatHashtbl.S] | Operations on `Hashtbl` with labels.
Labels [BatHashtbl] | Operations on `Hashtbl` with labels.
Labels [BatEnum] | Operations on `BatEnum` with labels.
Labels [BatArray.Cap] | Operations on `BatArray.Cap` with labels.
Labels [BatArray] | Operations on `Array` with labels.
Languages [BatGenlex] |
Lazy [Batteries_uni.Legacy] |
LazyList [Batteries_uni] |
Legacy [Batteries_uni] |
Lexing [Batteries_uni] |
Lexing [Batteries_uni.Legacy] |
Library [BatGenlex.Languages] |
List [Batteries_uni] |
List [Batteries_uni.Legacy] |
ListLabels [Batteries_uni.Legacy] |
Logger [Batteries_uni] |
M
Make [BatVect] |
Make [BatSet] | Functor building an implementation of the set structure given a totally ordered type.
Make [BatPathGen] | Constructs path handling module for string-like type and its operations given in `S`.
Make [BatMap] | Functor building an implementation of the map structure given a totally ordered type.
Make [BatInnerWeaktbl] | Functor building an implementation of the hashtable structure.
Make [BatHeap] | Functorized heaps over arbitrary orderings.
Make [BatHashtbl] | Functor building an implementation of the hashtable structure.
Make [BatGenlex.Languages] |
MakeLock [BatConcurrent] |
MakeTable [BatHashcons] |
Map [Batteries_uni] |
Map [Batteries_uni.Legacy] |
Map [BatSplay] |
Marshal [Batteries_uni] |
Marshal [Batteries_uni.Legacy] |
Monad [Batteries_uni] |
Monad [BatOption] | This module provides everything needed to write and execute computations in the Option monad.
Monad [BatEnum] | The BatEnum Monad
MoreLabels [Batteries_uni.Legacy] |
MultiPMap [Batteries_uni] |
Mutex [Batteries] |
Mutex [BatMutex] |
N
Nativeint [Batteries_uni] |
Nativeint [Batteries_uni.Legacy] |
NoLock [BatConcurrent] |
NumString [BatString] | uses numeric_compare as its ordering function
NumStringMap [BatMap] | A map on strings.
NumStringSet [BatSet] | A set of strings.
Number [Batteries_uni] |
O
OCaml [BatGenlex.Languages.Library] |
OfString [BatPathGen] | This implementation can be used with UTF-8, but encoding of used strings is not verified.
Oo [Batteries_uni] |
Oo [Batteries_uni.Legacy] |
Oo [BatOo] |
OperatorLift [BatPathGen.PathType] | Convenience operator for lifting primitive strings to `ustring` type.
Operators [BatPathGen.PathType] | Infix operators for path construction.
Opt [BatOptParse] | This module contains the basic functions and types for defining new option types and accessing the values of options.
OptParse [Batteries_uni] |
OptParser [BatOptParse] | This module contains the option parser itself.
Option [Batteries_uni] |
Output [BatInnerIO] |
P
PMap [Batteries_uni] |
PSet [Batteries_uni] |
Pair [Batteries_uni] |
Parse [BatPathGen.StringType] |
ParserCo [Batteries_uni] |
Parsing [Batteries_uni.Legacy] |
PathGen [Batteries_uni] |
Print [Batteries_uni] |
Printexc [Batteries_uni] |
Printexc [Batteries_uni.Legacy] |
Printf [Batteries_uni] |
Printf [Batteries_uni.Legacy] |
Printf [BatInnerIO] | Formatted output functions (also known as unparsing).
Q
Queue [Batteries_uni] |
Queue [Batteries_uni.Legacy] |
R
RMutex [Batteries] |
Random [Batteries_uni] |
Random [Batteries_uni.Legacy] |
Ref [Batteries_uni] |
RefList [Batteries_uni] |
Result [Batteries_uni] |
Return [Batteries_uni] |
Rope [Batteries_uni] |
RopeSet [BatSet] | A set of ropes.
S
Safe_float [BatFloat] | Operations on floating-point numbers, with exceptions raised in case of error.
Safe_int [BatInt] | Safe operations on integers.
Scanf [Batteries_uni] |
Scanf [Batteries_uni.Legacy] |
Scanning [BatScanf] | Scanning buffers
Seq [Batteries_uni] |
Set [Batteries_uni] |
Set [Batteries_uni.Legacy] |
Sort [Batteries_uni.Legacy] |
Source [BatParserCo] | A source for parsing.
Splay [Batteries_uni] |
Stack [Batteries_uni] |
Stack [Batteries_uni.Legacy] |
State [BatRandom] | Manipulate the current state of the random generator.
Std [Batteries_uni] |
StdLabels [Batteries_uni.Legacy] |
StdOpt [BatOptParse] | This module contains various standard options.
Str [Batteries_uni] |
Stream [Batteries_uni] |
Stream [Batteries_uni.Legacy] |
StreamLabels [BatStream] |
String [Batteries_uni] |
String [Batteries_uni.Legacy] |
StringLabels [Batteries_uni.Legacy] |
StringMap [BatMap] | A map on strings.
StringSet [BatSet] | A set of strings.
Substring [Batteries_uni] |
Sys [Batteries_uni] |
Sys [Batteries_uni.Legacy] |
T
Tuple [Batteries_uni] |
Tuple2 [Batteries_uni] |
Tuple2 [BatTuple] | Pairs.
Tuple3 [Batteries_uni] |
Tuple3 [BatTuple] | Triples.
Tuple4 [Batteries_uni] |
Tuple4 [BatTuple] | 4-Tuples.
Tuple5 [Batteries_uni] |
Tuple5 [BatTuple] | 5-Tuples.
U
UChar [Batteries_uni] |
UCharParser [Batteries_uni] |
UTF8 [Batteries_uni] |
Unit [Batteries_uni] |
Unix [Batteries_uni] |
Uref [Batteries_uni] |
V
Value_printer [Batteries_uni] |
Vect [Batteries_uni] |
W
Weak [Batteries_uni.Legacy] |
WithMonad [BatEnum] | Monadic operations on Enumerations containing monadic elements