(****************************************************************** [LibNN - Neural Networks Library] http://libnn.org Copyright (C) 2002 - 2003 LAGACHERIE Matthieu RICORDEAU Olivier This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. SPECIAL NOTE (the beerware clause): This software is free software. However, it also falls under the beerware special category. That is, if you find this software useful, or use it every day, or want to grant us for our modest contribution to the free software community, feel free to send us a beer from one of your local brewery. Our preference goes to Belgium abbey beers and irish stout (Guiness for strength!), but we like to try new stuffs. Authors: LAGACHERIE Matthieu Paper mail : 7 rue Delescluzes 94280 LE KREMLIN BICETRE, FRANCE E-mail : matthieu@libnn.org RICORDEAU Olivier Paper mail : 69 avenue d'Italie 75013 PARIS, FRANCE E-mail : olivier@libnn.org *****************************************************************) (** The Env module @author Matthieu Lagacherie @author Olivier Ricordeau @since 10/10/2003 *) class environment : object (** The verbosity level. *) val mutable _verbosity : int (** The weights random generator limit. *) val mutable _randLimit : float (** The channel on which LibNN is supposed to display normal information (like stdout on Unix). *) val mutable _outChannel : out_channel (** Sets the current output channel. *) method setOutChannel : out_channel -> unit (** Gets the current output channel. *) method getOutChannel : out_channel (** Displays a string on _outChannel. @param module_name The name of the module who is speaking (displayed in the output). @param msg The message to be displayed. @param min_verbosity_level If _verbosity >= this parameter, the message is displayed. *) method out : string -> string -> int -> unit (** The channel on which LibNN is supposed to display errors (like stderr on Unix). *) val mutable _errChannel : out_channel (** Sets the current error channel. *) method setErrChannel : out_channel -> unit (** Gets the current error channel. *) method getErrChannel : out_channel (** Displays a string on _errChannel. @param module_name The name of the module who is speaking (displayed in the output). @param msg The message to be displayed. @param min_verbosity_level If _verbosity >= this parameter, the message is displayed. *) method err : string -> string -> int -> unit (** Sets the current verbosity level. This method is not verbose because otherwise it would be impossible to totally mute LibNN. *) method setVerbosity : int -> unit (** Gets the current verbosity level. *) method getVerbosity : int (** Sets the current random limit. *) method setRandLimit : float -> unit (** Gets the current random limit. *) method getRandLimit : float (** Converts an otuput channel to a string (useful for dumping the current output channel as xml...). @param channel The channel to convert in string. *) method string_of_channel : out_channel -> string end val env : environment option ref val getEnv : unit -> environment