From 30034769128894884a94b1b99feb95737f163bab Mon Sep 17 00:00:00 2001 From: Aina Niemetz Date: Mon, 22 Mar 2021 08:07:02 -0700 Subject: [PATCH] FP: Add documentation for FloatingPointLiteral constructors. (#6183) --- src/util/floatingpoint_literal_symfpu.h.in | 15 +++++++++++++++ 1 file changed, 15 insertions(+) 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) -- 2.30.2