MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_Options.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
00025 //
00026 // ***********************************************************************
00028 //
00029 // Options for DenseLinAlgPack compilation
00030 //
00031
00032 #ifndef LINALGPACK_OPTIONS_H
00033 #define LINALGPACK_OPTIONS_H
00034
00035 #include "DenseLinAlgPack_extended_value_type.hpp"
00036 #include "Teuchos_ConfigDefs.hpp"
00037 #include "Teuchos_F77_wrappers.h"
00038
00039 #if !defined(LINALGPACK_NO_CHECKS)
00040
00041 /* * @name {\bf DenseLinAlgPack Options}.
00042   *
00043   * The header file DenseLinAlgPack_Options.hpp contains the defines for several macros that
00044   * determine how the library is built.  The user should comment out any
00045   * macros that her or she does not want to be defined.  The definition of
00046   * these macros cause the library code to assert the preconditions documented
00047   * for each of the member and non-member functions and throw the listed exceptions
00048   * if they are not satisfied.  Precondtions are supposed to be the
00049   * responcibility of the client code so the user may only want to define
00050   * these macros during debugging for better program verification.
00051   * If the user checks all of the preconditions listed in this documentation for the calls
00052   * to all functions then the checks performed by the library are redundant.
00053   */
00054 // @{
00055
00057 /* * If defined the library code checks to see if subscripts are in bounds for element access
00058   * an subregion indexing.  If the preconditions for the subscripting operations are
00059   * not satisfied then the listed exceptions will be thrown.
00060   */
00061 #ifndef LINALGPACK_CHECK_RANGE
00062 #define LINALGPACK_CHECK_RANGE 1
00063 #endif
00064
00066 /* * If defined the library code checks to see if the sizes of rhs arguments in expressions are compatible.
00067   * The exception std::length_error will be thrown if rhs sizes are not compatible.
00068   */
00069 #ifndef LINALGPACK_CHECK_RHS_SIZES
00070 #define LINALGPACK_CHECK_RHS_SIZES 1
00071 #endif
00072
00074 /* * If defined the library code checks to see if DVectorSlice and DMatrixSlice objects have valid constructions.
00075   * If they do not have valid constructions then an exception will be thrown.  The operation of these
00076   * checks may depend on the definition of the macro \Ref{LINALGPACK_CHECK_RANGE}.
00077   */
00078 #ifndef LINALGPACK_CHECK_SLICE_SETUP
00079 #define LINALGPACK_CHECK_SLICE_SETUP 1
00080 #endif
00081
00082 #endif
00083
00084 namespace DenseLinAlgPack{
00085
00087 typedef FortranTypes::f_dbl_prec    value_type;
00089 typedef Teuchos::Ordinal index_type;
00091 typedef Teuchos::Ordinal size_type;
00092
00093 }
00094
00095 // @}
00096
00097 #endif // LINALGPACK_OPTIONS_H