diff options
author | Aina Niemetz <aina.niemetz@gmail.com> | 2021-03-22 08:07:02 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-22 15:07:02 +0000 |
commit | 30034769128894884a94b1b99feb95737f163bab (patch) | |
tree | 6a7865b7be43b68e2d62e57efaa07f7fbf9ff1bf /src/util | |
parent | 93fd4aed186c3dfa1b0fa7bec102f5b94edca322 (diff) |
FP: Add documentation for FloatingPointLiteral constructors. (#6183)
Diffstat (limited to 'src/util')
-rw-r--r-- | src/util/floatingpoint_literal_symfpu.h.in | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/util/floatingpoint_literal_symfpu.h.in b/src/util/floatingpoint_literal_symfpu.h.in index 48b6ef53a..3040dae78 100644 --- a/src/util/floatingpoint_literal_symfpu.h.in +++ b/src/util/floatingpoint_literal_symfpu.h.in @@ -285,11 +285,26 @@ class FloatingPointLiteral friend class FloatingPoint; public: /** Constructors. */ + + /** Create an FP literal from a FloatingPoint. */ FloatingPointLiteral(FloatingPoint& other); // clang-format off #if @CVC4_USE_SYMFPU@ // clang-format on + + /** Create an FP literal from a symFPU unpacked float. */ FloatingPointLiteral(SymFPUUnpackedFloatLiteral symuf) : d_symuf(symuf){}; + + /** + * Create a FP literal from unpacked representation. + * + * This unpacked representation accounts for additional bits required for the + * exponent to allow subnormals to be normalized. + * + * This should NOT be used to create a literal from its IEEE bit-vector + * representation -- for this, the above constructor is to be used while + * creating a SymFPUUnpackedFloatLiteral via symfpu::unpack. + */ FloatingPointLiteral(const bool sign, const BitVector& exp, const BitVector& sig) |