GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
Table of Contents | < < Previous | Next >> |
Chapter Twenty-three — XBRL Functions (continued)
XBRLCompareFactValues Function
Overview
The XBRLCompareFactValues function compares two values with optional precision and tolerance.
Syntax/Parameters
Syntax
int = XBRLCompareFactValues ( string value_a, string value_b,
[string precision_a], [string precision_a],
[int
tolerance] );
Parameters
value_a
A string containing a representation of a monetary facts value.
value_b
A string containing a representation of a monetary facts value.
precision_a
An optional string containing the precision for value_a. If omitted, the default value is ‘0’.
precision_b
An optional string containing the precision for value_ab. If omitted, the default value is ‘0’.
tolerance
An optional int value specifying the level of tolerance in digits. The default value, is 0 or exact.
Return Value
An int as -1, 0, 1 or a formatted error code on failure. The extended error message will contain further information on the error.
Remarks
Data values are compared after adjusting common precision and then tolerance. The result:
a < b returns -1
a = b returns 0
a > b returns 1
The difference on the check is placed in the last error message.
Rounding is performed using the “Half to Even” method. See 4.6.7.1 ‘Correct to n Significant Figures’, ‘Rounding’ and ‘Truncation’ in the XBRL 2.1 Specification.
Related Functions
Platform Support
GoFiler Complete, GoFiler Corporate, GoXBRL
Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.