SP: Updated comments in sundials_types.h
* Programmer(s): Scott Cohen, Alan Hindmarsh, Radu Serban,
* Aaron Collier, and Slaven Peles @ LLNL
* -----------------------------------------------------------------
- * Copyright (c) 2002, The Regents of the University of California.
+ * LLNS Copyright Start
+ * Copyright (c) 2014, Lawrence Livermore National Security
+ * This work was performed under the auspices of the U.S. Department
+ * of Energy by Lawrence Livermore National Laboratory in part under
+ * Contract W-7405-Eng-48 and in part under Contract DE-AC52-07NA27344.
* Produced at the Lawrence Livermore National Laboratory.
* All rights reserved.
* For details, see the LICENSE file.
+ * LLNS Copyright End
*------------------------------------------------------------------
- * This header file exports two types: realtype and booleantype,
- * as well as the constants TRUE and FALSE.
+ * This header file exports three types: realtype, sunindextype and
+ * booleantype, as well as the constants TRUE and FALSE.
*
* Users should include the header file sundials_types.h in every
* program file and use the exported name realtype instead of
*
* The constants SUNDIALS_SINGLE_PRECISION, SUNDIALS_DOUBLE_PRECISION
* and SUNDIALS_LONG_DOUBLE_PRECISION indicate the underlying data
- * type of realtype. It is set at the configuration stage.
+ * type of realtype.
*
* The legal types for realtype are float, double and long double.
*
+ * The constants SUNDIALS_SIGNED_64BIT_TYPE, SUNDIALS_UNSIGNED_64BIT_TYPE,
+ * SUNDIALS_SIGNED_32BIT_TYPE and SUNDIALS_UNSIGNED_32BIT_TYPE indicate
+ * the underlying data type of sunindextype -- the integer data type
+ * used for vector and matrix indices.
+ *
+ * Data types are set at the configuration stage.
+ *
* The macro RCONST gives the user a convenient way to define
- * real-valued constants. To use the constant 1.0, for example,
+ * real-valued literal constants. To use the constant 1.0, for example,
* the user should write the following:
*
* #define ONE RCONST(1.0)
* to 1.0. If realtype is defined as a float, then RCONST(1.0)
* expands to 1.0F. If realtype is defined as a long double,
* then RCONST(1.0) expands to 1.0L. There is never a need to
- * explicitly cast 1.0 to (realtype).
+ * explicitly cast 1.0 to (realtype). The macro can be used for
+ * literal constants only. It cannot be used for expressions.
*------------------------------------------------------------------
*/
