xapian-core/common/serialise-double.h

   1 /** @file serialise-double.h
   2  * @brief functions to serialise and unserialise a double
   3  */
   4 /* Copyright (C) 2006,2012 Olly Betts
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  22  * IN THE SOFTWARE.
  23  */
  24
  25 #ifndef XAPIAN_INCLUDED_SERIALISE_DOUBLE_H
  26 #define XAPIAN_INCLUDED_SERIALISE_DOUBLE_H
  27
  28 #include <string>
  29
  30 /** Serialise a double to a string.
  31  *
  32  *  @param v    The double to serialise.
  33  *
  34  *  @return     Serialisation of @a v.
  35  */
  36 std::string serialise_double(double v);
  37
  38 /** Unserialise a double serialised by serialise_double.
  39  *
  40  *  @param p    Pointer to a pointer to the string, which will be advanced past
  41  *              the serialised double.
  42  *  @param end  Pointer to the end of the string.
  43  *
  44  *  @return     The unserialised double.
  45  */
  46 double unserialise_double(const char ** p, const char *end);
  47
  48 #endif