All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fixed-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 DOUBLE_CONVERSION_FIXED_DTOA_H_
29 #define DOUBLE_CONVERSION_FIXED_DTOA_H_
30 
31 #include "utils.h"
32 
33 #include "pxr/pxr.h"
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 namespace pxr_double_conversion {
38 
39 // Produces digits necessary to print a given number with
40 // 'fractional_count' digits after the decimal point.
41 // The buffer must be big enough to hold the result plus one terminating null
42 // character.
43 //
44 // The produced digits might be too short in which case the caller has to fill
45 // the gaps with '0's.
46 // Example: FastFixedDtoa(0.001, 5, ...) is allowed to return buffer = "1", and
47 // decimal_point = -2.
48 // Halfway cases are rounded towards +/-Infinity (away from 0). The call
49 // FastFixedDtoa(0.15, 2, ...) thus returns buffer = "2", decimal_point = 0.
50 // The returned buffer may contain digits that would be truncated from the
51 // shortest representation of the input.
52 //
53 // This method only works for some parameters. If it can't handle the input it
54 // returns false. The output is null-terminated when the function succeeds.
55 bool FastFixedDtoa(double v, int fractional_count,
56  Vector<char> buffer, int* length, int* decimal_point);
57 
58 } // namespace pxr_double_conversion
59 
60 PXR_NAMESPACE_CLOSE_SCOPE
61 
62 #endif // DOUBLE_CONVERSION_FIXED_DTOA_H_