summaryrefslogtreecommitdiff
path: root/src/util/rational_cln_imp.h
diff options
context:
space:
mode:
authorAina Niemetz <aina.niemetz@gmail.com>2021-04-12 12:31:43 -0700
committerGitHub <noreply@github.com>2021-04-12 19:31:43 +0000
commit7ec30058750611786b1b597816c8a23e28bb5812 (patch)
treee59b1de0078dc04d3a9c212cf9e6ebfd70cbb7f4 /src/util/rational_cln_imp.h
parent7361b587e9a1b717dfa906d02f66feb6896e80dd (diff)
Refactor and update copyright headers. (#6316)
Diffstat (limited to 'src/util/rational_cln_imp.h')
-rw-r--r--src/util/rational_cln_imp.h56
1 files changed, 27 insertions, 29 deletions
diff --git a/src/util/rational_cln_imp.h b/src/util/rational_cln_imp.h
index 4614620d5..c3808a5d9 100644
--- a/src/util/rational_cln_imp.h
+++ b/src/util/rational_cln_imp.h
@@ -1,19 +1,17 @@
-/********************* */
-/*! \file rational_cln_imp.h
- ** \verbatim
- ** Top contributors (to current version):
- ** Tim King, Gereon Kremer, Morgan Deters
- ** This file is part of the CVC4 project.
- ** Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
- ** in the top-level source directory and their institutional affiliations.
- ** All rights reserved. See the file COPYING in the top-level source
- ** directory for licensing information.\endverbatim
- **
- ** \brief Multiprecision rational constants; wraps a CLN multiprecision
- ** rational.
- **
- ** Multiprecision rational constants; wraps a CLN multiprecision rational.
- **/
+/******************************************************************************
+ * Top contributors (to current version):
+ * Tim King, Gereon Kremer, Morgan Deters
+ *
+ * This file is part of the cvc5 project.
+ *
+ * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
+ * in the top-level source directory and their institutional affiliations.
+ * All rights reserved. See the file COPYING in the top-level source
+ * directory for licensing information.
+ * ****************************************************************************
+ *
+ * Multiprecision rational constants; wraps a CLN multiprecision rational.
+ */
#include "cvc4_public.h"
@@ -40,19 +38,19 @@
namespace cvc5 {
/**
- ** A multi-precision rational constant.
- ** This stores the rational as a pair of multi-precision integers,
- ** one for the numerator and one for the denominator.
- ** The number is always stored so that the gcd of the numerator and denominator
- ** is 1. (This is referred to as referred to as canonical form in GMP's
- ** literature.) A consequence is that that the numerator and denominator may be
- ** different than the values used to construct the Rational.
- **
- ** NOTE: The correct way to create a Rational from an int is to use one of the
- ** int numerator/int denominator constructors with the denominator 1. Trying
- ** to construct a Rational with a single int, e.g., Rational(0), will put you
- ** in danger of invoking the char* constructor, from whence you will segfault.
- **/
+ * A multi-precision rational constant.
+ * This stores the rational as a pair of multi-precision integers,
+ * one for the numerator and one for the denominator.
+ * The number is always stored so that the gcd of the numerator and denominator
+ * is 1. (This is referred to as referred to as canonical form in GMP's
+ * literature.) A consequence is that that the numerator and denominator may be
+ * different than the values used to construct the Rational.
+ *
+ * NOTE: The correct way to create a Rational from an int is to use one of the
+ * int numerator/int denominator constructors with the denominator 1. Trying
+ * to construct a Rational with a single int, e.g., Rational(0), will put you
+ * in danger of invoking the char* constructor, from whence you will segfault.
+ */
class CVC4_EXPORT Rational
{
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback