Index of values


(<<) [Sconf.OCaml_conf]
v1 << v2 returns true if version v1 is strictly inferior to version v2.
(@>) [Searray]
t @> n converts a regular integer into a position for extensible array t.
(@@) [Searray]
Same as Searray.get.
(@~) [Searray]
Same as Searray.get but use a regular integer as indice.
(~~) [Searray]
Same as Searray.int.

A
access_map [Sconf.OCaml_conf]
access_ok_errors [Sconf.OCaml_conf]
add [Stmap.S]
add [Searray]
add t v adds a new value in the array, returning the indice of the new value.
add_conf_variables [Sconf.OCaml_conf]
add_subst [Sconf.OCaml_conf]
add_to_log [Sconf.OCaml_conf]
add_to_log str writes the given string to the Sconf.OCaml_conf.log_file, with the date and time at the beginning of the line and an ending new line.
as_list [Shistory]

B
buffer_size [Sconf.OCaml_conf]
byte_ext_to_opt [Sconf.OCaml_conf]
If the given filename has a .cmo (resp.

C
cameleon2_libdir [Sconf]
cameleon2_libdir () checks that the cam-config2.x tool is in the PATH, then runs it with the -l option to retrieve the directory of Cameleon2 libraries.
can_compile [Sconf.OCaml_conf]
can_compile_prog [Sconf.OCaml_conf]
can_link [Sconf.OCaml_conf]
can_redo [Shistory]
capitalize_name [Sstring]
capitalize_name s lowers the case of the given string (but not the accents) and uppers the letters at the beginning of the words.
card [Stmap.S]
check_conf_versions [Sconf.OCaml_conf]
check_conf_version conf verifies that each program of the given configuration is of the correct version.
check_cryptokit [Sconf]
check_cryptokit conf checks that we can link with Cryptokit.
check_for_opt_prog [Sconf.OCaml_conf]
check_for_opt_prog version prog checks whether the prog.opt program is in the required version, and if so returns this program name; else it returns the given program name.
check_gmp [Sconf]
check_gmp conf checks that we can link with Gmp, using "+gmp" as include directory.
check_gnuplot_has_boxes [Sconf]
gnuplot_has_boxes conf returns whether the OCaml gnuplot library defines a Boxes constructor, using "+gnuplot" as include directory.
check_lablgtk2 [Sconf]
check_lablgtk2 conf checks that we can link with Lablgtk2, using "+lablgtk2" as include directory.
check_mlgraph [Sconf]
check_mlgraph conf checks that we can link with Mlgraph, using "+mlgraph" as include directory.
check_ocaml_gnuplot [Sconf]
check_gnuplot conf checks that we can link with OCaml-gnuplot, using "+gnuplot" as include directory.
check_ocamlfind_package [Sconf.OCaml_conf]
check_ocgi [Sconf]
check_ocgi conf checks that we can link with Ocgi.
check_version [Sconf.OCaml_conf]
check_version version prog tries to run prog -version and return whether the given version string is a suffix of the first line printed.
check_xml_light [Sconf]
check_xml_light conf checks that we can link with Xml-light.
chop_n_char [Sstring]
chop_n_char n s returns the given string where characters after position n are replaced by "...".
color_debug [Sdebug]
color_stderr [Sdebug]
color_stdout [Sdebug]
color_verbose [Sdebug]
compare_key [Stmap.S]
concat_matrices_i [Smatrices.Simple]
concat_matrices_j [Smatrices.Simple]
copy [Searray]
copy t returns a copy of the given array.
count_char [Sstring]
count_char s c count the number to occurences of character c in string s.
create [Stmap.S]
create [Shistory]
create v creates an history with a first value v.
create [Searray]
Create a new extensible array.
create_file [Sfile]
Create the given empty file.
create_temp_file [Sconf.OCaml_conf]
create_temp_files ?ext ?contents () creates a temporary empty file and returns its name.

D
debug [Sconf.OCaml_conf]
Set this to true to enable debug mode.
debug [Sdebug]
decr_level [Sdebug.Level]
descr_from_string [Sconf.OCaml_conf]
detect_lablgl [Sconf]
detect_lablgl conf checks that we can link with LablGL, trying first with Togl, then with Glut.
detect_lablgtk2 [Sconf]
detect_lablgtk2 conf checks that we can link with LablGtk2, trying first with ocamlfind installation directory, then with default installation directory.
detect_lablgtkextras [Sconf]
detect_lablgtkextras conf lablgtk_includes checks that we can link with LablGtk-extras, trying first with ocamlfind installation directory, then with default installation directory.
detect_mysql [Sconf]
detect_mysql conf checks that we can link with OCaml-MySQL, using ocamlfind query mysql to retrieve the include directories.
detect_xml_light [Sconf]
detect_xml_light conf checks that we can link with Xml-light, trying first with ocamlfind installation directory, then with default installation directory, then in +xml-light directory (for debian installations).
dummy_version [Sconf.OCaml_conf]
The dummy version number = [0].

E
exec_and_get_first_line [Sconf.OCaml_conf]
exec_and_get_first_line com args tries to execute the given command with the given arguments, and read the first line printed by the commande on its standard output.
exec_status_ok [Sconf.OCaml_conf]
exec_status_ok st returns true if the given return status is Unix.WEXITED 0.
execvp [Sconf.OCaml_conf]
execvp_redirect [Sconf.OCaml_conf]
execvp_to_list [Sconf.OCaml_conf]

F
fatal_error [Sconf.OCaml_conf]
The function to print a given fatal error message.
fatal_error [Smisc]
fatal_error s prints the given string on stderr and exit with code 1.
file_of_string [Sconf.OCaml_conf]
file_of_string ~contents ~file creates the given file with the given string str as contents.
file_of_string [Sfile]
file_of_string ~file str creates a file named filename whose content is str.
file_of_value [Sfile]
file_of_value filename v writes a value v to filename using output_value.
find [Stmap.S]
find [Sfile.Find]
find [Searray]
find t pred returns the indice of the first value for which pred returns true.
find_in_path [Sconf.OCaml_conf]
find_in_path predicate paths file returns the list of complete filenames build from the directories and the filename, and verifying the given predicate.
find_list [Sfile.Find]
first_sentence [Sstring]
first_sentence ?limit s returns the first sentence of s, in the limit of limit characters.
fold [Stmap.S]
fold_left [Searray]
Same as Array.fold_left but on an extensible array.
fold_lefti [Searray]
Same as Array.fold_left but on an extensible array, and the function takes also the indice of the value.
fold_right [Searray]
Same as Array.fold_right but on an extensible array.
fold_righti [Searray]
Same as Array.fold_right but on an extensible array, and the function takes also the indice of the value.

G
get [Stmap.S]
get [Shistory]
get [Searray]
get t pos returns the value in t at position ind.
get_opt_conf [Sconf.OCaml_conf]
get_opt_conf conf returns the same configuration where some program names have been replaced by the "opt" version ("..../ocamlc.opt" instead of "..../ocamlc" for example).
get_path [Sconf.OCaml_conf]
get_path () returns the list of directories indicated by the PATH environement variable.
get_substs_list [Sconf.OCaml_conf]
group_distances [Smatrices.Distances]

H
header [Smailparse]
header h msg returns the contents of header named h in message msg, or the empty string if this header is missing.

I
imp_as_list [Shistory]
imp_can_redo [Shistory]
imp_create [Shistory]
imp_get [Shistory]
imp_push [Shistory]
imp_redo [Shistory]
imp_to_t [Shistory]
imp_undo [Shistory]
in_channel_is_file [Sfile]
in_channel_is_file channel returns true if the given in_channel corresponds to a file.
incr_level [Sdebug.Level]
input_lines [Sconf.OCaml_conf]
input_lines channel return the list of lines from the given channel.
insert [Searray]
insert t pos v inserts a value v in array t at position pos.
int [Stmap.S]
int [Searray]
int pos convert an indice to a reguler integer.
is_prefix [Sstring]
is_prefix pattern s returns true if string s begins with pattern.
is_suffix [Sconf.OCaml_conf]
is_suffix ~suf s returns true if the string suf is a suffix of s.
iter [Stmap.S]
iter [Searray]
Same as Array.iter but on an extensible array.
iter_file_lines [Sfile]
iter_file_lines f filename reads filename line by line, applying f to each one.
iter_lines [Sfile]
iter_lines f in_channel reads in_channel line by line, applying f to each one.
iteri [Searray]
Same as Array.iteri but on an extensible array.

K
keep_alpha_nums [Sstring]
Return the given string where only alphanums char are kept.

L
latex [Smatrices.Distances]
latex [Smatrices.Simple]
latex_sorted_dists [Smatrices.Distances]
length [Searray]
length t returns the length of the array, that is the number of values in it.
level [Sdebug.Level]
list_chop [Slist]
list_chop n l returns the n first elements of list l or the whole list if n >= List.length l.
list_diff [Slist]
list_diff l1 l2 returns the list l1 - l2.
list_of_path [Sconf.OCaml_conf]
list_of_path string returns the list of directories from the given string in path format.
list_remove_doubles [Slist]
list_remove_doubles ?pred l remove doubles in the given list l, according to the optional equality function pred.
load_dist_matrix [Smatrices.Distances]
load_file [Sfile]
load_file f file opens file and use f to read from this file.
load_matrix [Smatrices.Simple]
log_file [Sconf.OCaml_conf]
The name of the log file.
lowercase [Sstring]
lowercase s lowers the case of the given string, including accentuated characters.

M
make_int_list [Slist]
make_int_list low high builds a list of integers, from low to high.
make_list [Slist]
make_list n ele builds a list of n elements ele.
make_matrix [Smatrices.Distances]
mapi [Searray]
Same as Array.mapi but on an extensible array.
mapi_as_list [Searray]
Same as Searray.mapi but returns a list instead of an extensible array.
md5sum_of_file [Smisc]
md5sum_of_file file returns the md5sum from the content of the given file, using the md5sum tool.
md5sum_of_string [Smisc]
md5sum_of_file file returns the md5sum from the content of the given file, using the md5sum tool.
media [Sdebug.Media]
modify [Stmap.S]
my_int_of_string [Smisc]
my_int_of_string acts like Pervasives.int_of_string except that it does not fail when the string begins with one or more '+' sign(s).

N
no_blanks [Sstring]
no_blanks s returns the given string without any blank characters, i.e.

O
ocaml_conf [Sconf.OCaml_conf]
ocaml_conf () detects and returns the Objective Caml configuration found from the PATH.
ocaml_defined [Sconf.OCaml_conf]
ocaml_libdir [Sconf.OCaml_conf]
ocaml_libdir conf uses the ocamlc program of the given configuration to retrieve the library directory.
ocaml_prog [Sconf.OCaml_conf]
ocaml_prog file return the first executable called file in the directories of the PATH environment variable.
ocaml_value_has_type [Sconf.OCaml_conf]
ocamlc_of_mode [Sconf.OCaml_conf]
ocamlfind_query [Sconf.OCaml_conf]
ocamlfind_query conf package returns the first line printed by "ocamlfind query package".
ocamlfind_query_version [Sconf.OCaml_conf]
opt_of_string [Sstring]
opt_of_string s returns None if the string if empty (length is 0) or Some s.
out_channel_is_file [Sfile]
out_channel_is_file channel returns true if the given out_channel corresponds to a file.
output [Sdebug.Media]
output_substs [Sconf.OCaml_conf]
output_substs_to_file [Sconf.OCaml_conf]

P
parse_message [Smailparse]
Parse the given textual message and return its structure.
path_of_list [Sconf.OCaml_conf]
path_of_list paths builds a string in path format.
path_sep [Sconf.OCaml_conf]
path_sep_regexp [Sconf.OCaml_conf]
perm [Sconf.OCaml_conf]
print [Sconf.OCaml_conf]
The function used to print progress messages and other information.
print [Sdebug.Log_color]
print [Sdebug.Log]
print_array [Sarray]
print_array out_channel string_of_ele array prints the given array of elements in the given channel, with a newline after each one; string_of_ele is used to get a string from an element.
print_check [Sequation]
This variable is used to store a print function used to print checks on results.
print_conf [Sconf.OCaml_conf]
print_conf conf prints the given configuration using !Sconf.OCaml_conf.print.
print_list [Slist]
print_list out_channel string_of_ele list prints the given list of elements in the given channel, with a newline after each one; string_of_ele is used to get a string from an element.
probabilities [Squantiles.Chi_deux]
probability_of_quantile [Squantiles.Chi_deux]
probability_of_quantile degree q returns the probability corresponding to the given degree (<=100) and the given quantile.
push [Shistory]

Q
quantile_of_freedom_degree [Squantiles.Chi_deux]
quantile_of_freedom_degree n returns the quantile for the given freedrom degree n.

R
redo [Shistory]
remove [Stmap.S]
remove_empty_strings [Sconf.OCaml_conf]
replace_in_string [Sstring]
replace_in_string ~pat ~subs ~s replaces all occurences of pattern pat by subs in string s.
restart_on_EINTR [Sconf.OCaml_conf]

S
safe_main [Smisc]
safe_main f calls f () but handles Sys_error and Failure exceptions by exiting with error code 1.
safe_remove_file [Sfile]
Remove the given file, and ignore the error if the file does not exist (catch Sys_error).
sendmail [Smail.Sendmail]
sendmail mail send the given mail with the mhmail command.
sendmail [Smail.Mhmail]
sendmail mail send the given mail with the mhmail command.
sendmail [Smail.SMTP]
sendmail host port mail send the given mail through the given SMTP server.
set [Searray]
set t pos v sets the given value v in t at position pos.
set_colors [Sdebug.Color_media]
set_colors [Sdebug.FOut_channel_media_color]
set_level [Sdebug.Level]
set_media [Sdebug.Media]
solve_deg_2 [Sequation]
Solving (a X^2 + b X + c = 0.0)
solve_deg_3 [Sequation]
Solving (a X^3 + b X^2 + c X + d = 0.0)
solve_deg_4 [Sequation]
Solving (a X^4 + b X^3 + c X^2 + d X + e = 0.0)
split_list [Slist]
split_list len l splits the given list l in a list of lists, each of length len, except eventually the last one.
split_string [Sstring]
Separate the given string according to the given list of characters.
stderr [Sdebug]
stdout [Sdebug]
store_dist_matrix [Smatrices.Distances]
store_file [Sfile]
store_file f file v opens file and uses f to write value v to the file.
store_matrix [Smatrices.Simple]
string_from_descr [Sconf.OCaml_conf]
string_of_bool [Sconf.OCaml_conf]
!string_of_bool b should return a message according to the given boolean.
string_of_com_args [Sconf.OCaml_conf]
string_of_date [Sconf.OCaml_conf]
string_of_date [Sstring]
Return a string to represent the given date.
string_of_file [Sconf.OCaml_conf]
string_of_files returns the contents of the given file as a string.
string_of_file [Sfile]
string_of_file filename returns the content of filename in the form of one string.
string_of_in_channel [Sstring]
string_of_in_channel ch reads the given channel until the end, returning the content in the form of one string.
string_of_includes [Sconf.OCaml_conf]
string_of_mode [Sconf.OCaml_conf]
string_of_opt [Sstring]
string_of_opt s_opt returns the empty string if s_opt = None or s if s_opt = Some s.
string_of_probability [Squantiles.Chi_deux]
string_of_version [Sconf.OCaml_conf]
string_of_version v returns a string to display the given version.
strip_string [Sstring]
strip_string s removes all leading and trailing spaces from the given string.
subdirs [Sfile]
subdirs path returns the list of subdirectories of the given directory name.
subst_val [Sconf.OCaml_conf]
substs [Sconf.OCaml_conf]

T
t_to_imp [Shistory]
temp_files_ext [Sconf.OCaml_conf]
The default extension for the temporary files created.
temp_files_prefix [Sconf.OCaml_conf]
The prefix of the temporary files created.
testfile [Sconf.OCaml_conf]
testfile flags filename tests whether the given file verifies the given properties.
to_array [Searray]
to_array t returns a regular array from an extensible array.
try_finalize [Sconf.OCaml_conf]
try_finalize [Smisc]
try_finalize f x g y applies f to x and return the result or raises an exception, but in all cases g is applied to y before returning or raising the exception.
try_run [Sconf.OCaml_conf]

U
undo [Shistory]
unlink_f [Sconf.OCaml_conf]
unlink_f file removes the given file if it exists.
unopt [Smisc]
unopt v returns v' if v = Some v' and raises Invalid_argument "unopt None" otherwize.

V
value_of_file [Sfile]
value_of_file filename reads a value from filename using input_value.
verbose [Sdebug]
version_of_ocaml_version_string [Sconf.OCaml_conf]
version_of_ocaml_version_string str returns a Sconf.OCaml_conf.version value from the string representing an ocaml version (which can contain '+', a date, ...).
version_of_string [Sconf.OCaml_conf]
version_of_string s returns a version number from the given string s.