js/src/v8-dtoa/fast-dtoa.h

   1 // Copyright 2010 the V8 project authors. All rights reserved.
   2 // Redistribution and use in source and binary forms, with or without
   3 // modification, are permitted provided that the following conditions are
   4 // met:
   5 //
   6 //     * Redistributions of source code must retain the above copyright
   7 //       notice, this list of conditions and the following disclaimer.
   8 //     * Redistributions in binary form must reproduce the above
   9 //       copyright notice, this list of conditions and the following
  10 //       disclaimer in the documentation and/or other materials provided
  11 //       with the distribution.
  12 //     * Neither the name of Google Inc. nor the names of its
  13 //       contributors may be used to endorse or promote products derived
  14 //       from this software without specific prior written permission.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 #ifndef V8_FAST_DTOA_H_
  29 #define V8_FAST_DTOA_H_
  30
  31 namespace v8 {
  32 namespace internal {
  33
  34 // FastDtoa will produce at most kFastDtoaMaximalLength digits. This does not
  35 // include the terminating '\0' character.
  36 static const int kFastDtoaMaximalLength = 17;
  37
  38 // Provides a decimal representation of v.
  39 // v must be a strictly positive finite double.
  40 // Returns true if it succeeds, otherwise the result can not be trusted.
  41 // There will be *length digits inside the buffer followed by a null terminator.
  42 // If the function returns true then
  43 //   v == (double) (buffer * 10^(point - length)).
  44 // The digits in the buffer are the shortest representation possible: no
  45 // 0.099999999999 instead of 0.1.
  46 // The last digit will be closest to the actual v. That is, even if several
  47 // digits might correctly yield 'v' when read again, the buffer will contain the
  48 // one closest to v.
  49 // The variable 'sign' will be '0' if the given number is positive, and '1'
  50 //   otherwise.
  51 bool FastDtoa(double d,
  52               Vector<char> buffer,
  53               int* length,
  54               int* point);
  55
  56 } }  // namespace v8::internal
  57
  58 #endif  // V8_FAST_DTOA_H_