Tools.hpp 2.47 KB
Newer Older
Mathieu Faverge's avatar
Mathieu Faverge committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/*
** This file is part of the ViTE project.
**
** This software is governed by the CeCILL-A license under French law
** and abiding by the rules of distribution of free software. You can
** use, modify and/or redistribute the software under the terms of the
** CeCILL-A license as circulated by CEA, CNRS and INRIA at the following
** URL: "http://www.cecill.info".
** 
** As a counterpart to the access to the source code and rights to copy,
** modify and redistribute granted by the license, users are provided
** only with a limited warranty and the software's author, the holder of
** the economic rights, and the successive licensors have only limited
** liability.
** 
** In this respect, the user's attention is drawn to the risks associated
** with loading, using, modifying and/or developing or reproducing the
** software by the user in light of its specific status of free software,
** that may mean that it is complicated to manipulate, and that also
** therefore means that it is reserved for developers and experienced
** professionals having in-depth computer knowledge. Users are therefore
** encouraged to load and test the software's suitability as regards
** their requirements in conditions enabling the security of their
** systems and/or data to be ensured and, more generally, to use and
** operate it in the same conditions as regards security.
** 
** The fact that you are presently reading this means that you have had
** knowledge of the CeCILL-A license and that you accept its terms.
**
**
31
** ViTE developers are (for version 0.* to 1.0):
Mathieu Faverge's avatar
Mathieu Faverge committed
32 33 34 35 36 37 38 39 40 41 42
**
**        - COULOMB Kevin
**        - FAVERGE Mathieu
**        - JAZEIX Johnny
**        - LAGRASSE Olivier
**        - MARCOUEILLE Jule
**        - NOISETTE Pascal
**        - REDONDY Arthur
**        - VUCHENER Clément 
**
*/
43 44 45 46 47 48 49 50 51
/*!
 *\file Tools.hpp
 *\brief This file contains functions that are used in different modules and do not belong to a particular class.
 */

#ifndef TOOLS_HPP
#define TOOLS_HPP

/*!
Johnny Jazeix's avatar
Johnny Jazeix committed
52
 * \fn convert_to_double(const std::string args)
53
 * \brief Convert the string in double
Johnny Jazeix's avatar
Johnny Jazeix committed
54 55
 * \param args the string to be doublized.
 * \return the double well converted or -1. on error.
56
 */
Johnny Jazeix's avatar
Johnny Jazeix committed
57
double convert_to_double(const std::string args);
58

59 60
// #define MIN(x,y) (((x)<(y))?(x):(y))
// #define MAX(x,y) (((x)<(y))?(y):(x))
61

62
/*!
63 64 65 66
  \fn clockGet(void)
  \brief Timing routine.
  Uses different timing routines depending on the machine architecture.
  \return Returns the time ellapsed since 'clockStart'.
67
 */
68
double clockGet (void);
69 70

#endif // TOOLS_HPP