bundles / numpy 2.4.4 / numpy / format_float_scientific
function
numpy:format_float_scientific
source: /numpy/_core/arrayprint.py :1131
Signature
def format_float_scientific ( x , precision = None , unique = True , trim = k , sign = False , pad_left = None , exp_digits = None , min_digits = None ) Summary
Format a floating-point scalar as a decimal string in scientific notation.
Extended Summary
Provides control over rounding, trimming and padding. Uses and assumes IEEE unbiased rounding. Uses the "Dragon4" algorithm.
Parameters
x: python float or numpy floating scalarValue to format.
precision: non-negative integer or None, optionalMaximum number of digits to print. May be None if
uniqueisTrue, but must be an integer if unique isFalse.unique: boolean, optionalIf
True, use a digit-generation strategy which gives the shortest representation which uniquely identifies the floating-point number from other values of the same type, by judicious rounding. Ifprecisionis given fewer digits than necessary can be printed. Ifmin_digitsis given more can be printed, in which cases the last digit is rounded with unbiased rounding. IfFalse, digits are generated as if printing an infinite-precision value and stopping afterprecisiondigits, rounding the remaining value with unbiased roundingtrim: one of 'k', '.', '0', '-', optionalControls post-processing trimming of trailing digits, as follows:
'k'keep trailing zeros, keep decimal point (no trimming)
'.'trim all trailing zeros, leave decimal point
'0'trim all but the zero before the decimal point. Insert the zero if it is missing.
'-'trim trailing zeros and any trailing decimal point
sign: boolean, optionalWhether to show the sign for positive values.
pad_left: non-negative integer, optionalPad the left side of the string with whitespace until at least that many characters are to the left of the decimal point.
exp_digits: non-negative integer, optionalPad the exponent with zeros until it contains at least this many digits. If omitted, the exponent will be at least 2 digits.
min_digits: non-negative integer or None, optionalMinimum number of digits to print. This only has an effect for
unique=True. In that case more digits than necessary to uniquely identify the value may be printed and rounded unbiased.
Returns
rep: stringThe string representation of the floating point value
Examples
import numpy as np np.format_float_scientific(np.float32(np.pi)) s = np.float32(1.23e24) np.format_float_scientific(s, unique=False, precision=15) np.format_float_scientific(s, exp_digits=4)✓
See also
- format_float_positional
Aliases
-
numpy.format_float_scientific