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
00013 // License, or (at your option) any later version.
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 // ***********************************************************************
00027 // @HEADER
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_F77_wrappers.h"
00037 
00038 #if !defined(LINALGPACK_NO_CHECKS)
00039 
00040 /* * @name {\bf DenseLinAlgPack Options}.
00041   *
00042   * The header file DenseLinAlgPack_Options.hpp contains the defines for several macros that
00043   * determine how the library is built.  The user should comment out any
00044   * macros that her or she does not want to be defined.  The definition of
00045   * these macros cause the library code to assert the preconditions documented
00046   * for each of the member and non-member functions and throw the listed exceptions
00047   * if they are not satisfied.  Precondtions are supposed to be the 
00048   * responcibility of the client code so the user may only want to define
00049   * these macros during debugging for better program verification.
00050   * If the user checks all of the preconditions listed in this documentation for the calls
00051   * to all functions then the checks performed by the library are redundant.
00052   */
00053 // @{
00054 
00056 /* * If defined the library code checks to see if subscripts are in bounds for element access
00057   * an subregion indexing.  If the preconditions for the subscripting operations are
00058   * not satisfied then the listed exceptions will be thrown.
00059   */
00060 #ifndef LINALGPACK_CHECK_RANGE
00061 #define LINALGPACK_CHECK_RANGE 1
00062 #endif
00063 
00065 /* * If defined the library code checks to see if the sizes of rhs arguments in expressions are compatible.
00066   * The exception std::length_error will be thrown if rhs sizes are not compatible.
00067   */
00068 #ifndef LINALGPACK_CHECK_RHS_SIZES
00069 #define LINALGPACK_CHECK_RHS_SIZES 1
00070 #endif
00071 
00073 /* * If defined the library code checks to see if DVectorSlice and DMatrixSlice objects have valid constructions.
00074   * If they do not have valid constructions then an exception will be thrown.  The operation of these
00075   * checks may depend on the definition of the macro \Ref{LINALGPACK_CHECK_RANGE}.
00076   */
00077 #ifndef LINALGPACK_CHECK_SLICE_SETUP
00078 #define LINALGPACK_CHECK_SLICE_SETUP 1
00079 #endif
00080 
00081 #endif
00082 
00083 namespace DenseLinAlgPack{
00085 typedef FortranTypes::f_dbl_prec    value_type;
00087 typedef FortranTypes::f_int       index_type;
00089 typedef FortranTypes::f_int       size_type;
00090 
00091 }
00092 
00093 // @}
00094 
00095 #endif // LINALGPACK_OPTIONS_H

Generated on Thu Sep 18 12:35:16 2008 for MOOCHO (Single Doxygen Collection) by doxygen 1.3.9.1