fast-dtoa.h 2.38 KB
Newer Older
1
// Copyright 2011 the V8 project authors. All rights reserved.
2 3
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
4

5 6
#ifndef V8_FAST_DTOA_H_
#define V8_FAST_DTOA_H_
7

8 9
#include "src/vector.h"

10 11 12
namespace v8 {
namespace internal {

13 14 15 16 17 18 19 20 21 22
enum FastDtoaMode {
  // Computes the shortest representation of the given input. The returned
  // result will be the most accurate number of this length. Longer
  // representations might be more accurate.
  FAST_DTOA_SHORTEST,
  // Computes a representation where the precision (number of digits) is
  // given as input. The precision is independent of the decimal point.
  FAST_DTOA_PRECISION
};

23
// FastDtoa will produce at most kFastDtoaMaximalLength digits. This does not
24
// include the terminating '\0' character.
25
const int kFastDtoaMaximalLength = 17;
26 27

// Provides a decimal representation of v.
28 29 30 31 32
// The result should be interpreted as buffer * 10^(point - length).
//
// Precondition:
//   * v must be a strictly positive finite double.
//
33 34
// Returns true if it succeeds, otherwise the result can not be trusted.
// There will be *length digits inside the buffer followed by a null terminator.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
// If the function returns true and mode equals
//   - FAST_DTOA_SHORTEST, then
//     the parameter requested_digits is ignored.
//     The result satisfies
//         v == (double) (buffer * 10^(point - length)).
//     The digits in the buffer are the shortest representation possible. E.g.
//     if 0.099999999999 and 0.1 represent the same double then "1" is returned
//     with point = 0.
//     The last digit will be closest to the actual v. That is, even if several
//     digits might correctly yield 'v' when read again, the buffer will contain
//     the one closest to v.
//   - FAST_DTOA_PRECISION, then
//     the buffer contains requested_digits digits.
//     the difference v - (buffer * 10^(point-length)) is closest to zero for
//     all possible representations of requested_digits digits.
//     If there are two values that are equally close, then FastDtoa returns
//     false.
// For both modes the buffer must be large enough to hold the result.
53 54 55
V8_EXPORT_PRIVATE bool FastDtoa(double d, FastDtoaMode mode,
                                int requested_digits, Vector<char> buffer,
                                int* length, int* decimal_point);
56

57 58
}  // namespace internal
}  // namespace v8
59

60
#endif  // V8_FAST_DTOA_H_