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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 //
00042 // Options for DenseLinAlgPack compilation
00043 //
00044 
00045 #ifndef LINALGPACK_OPTIONS_H
00046 #define LINALGPACK_OPTIONS_H
00047 
00048 #include "DenseLinAlgPack_extended_value_type.hpp"
00049 #include "Teuchos_ConfigDefs.hpp"
00050 #include "Teuchos_F77_wrappers.h"
00051 
00052 #if !defined(LINALGPACK_NO_CHECKS)
00053 
00054 /* * @name {\bf DenseLinAlgPack Options}.
00055   *
00056   * The header file DenseLinAlgPack_Options.hpp contains the defines for several macros that
00057   * determine how the library is built.  The user should comment out any
00058   * macros that her or she does not want to be defined.  The definition of
00059   * these macros cause the library code to assert the preconditions documented
00060   * for each of the member and non-member functions and throw the listed exceptions
00061   * if they are not satisfied.  Precondtions are supposed to be the 
00062   * responcibility of the client code so the user may only want to define
00063   * these macros during debugging for better program verification.
00064   * If the user checks all of the preconditions listed in this documentation for the calls
00065   * to all functions then the checks performed by the library are redundant.
00066   */
00067 // @{
00068 
00070 /* * If defined the library code checks to see if subscripts are in bounds for element access
00071   * an subregion indexing.  If the preconditions for the subscripting operations are
00072   * not satisfied then the listed exceptions will be thrown.
00073   */
00074 #ifndef LINALGPACK_CHECK_RANGE
00075 #define LINALGPACK_CHECK_RANGE 1
00076 #endif
00077 
00079 /* * If defined the library code checks to see if the sizes of rhs arguments in expressions are compatible.
00080   * The exception std::length_error will be thrown if rhs sizes are not compatible.
00081   */
00082 #ifndef LINALGPACK_CHECK_RHS_SIZES
00083 #define LINALGPACK_CHECK_RHS_SIZES 1
00084 #endif
00085 
00087 /* * If defined the library code checks to see if DVectorSlice and DMatrixSlice objects have valid constructions.
00088   * If they do not have valid constructions then an exception will be thrown.  The operation of these
00089   * checks may depend on the definition of the macro \Ref{LINALGPACK_CHECK_RANGE}.
00090   */
00091 #ifndef LINALGPACK_CHECK_SLICE_SETUP
00092 #define LINALGPACK_CHECK_SLICE_SETUP 1
00093 #endif
00094 
00095 #endif
00096 
00097 namespace DenseLinAlgPack{
00098 
00100 typedef FortranTypes::f_dbl_prec    value_type;
00102 typedef Teuchos::Ordinal index_type;
00104 typedef Teuchos::Ordinal size_type;
00105 
00106 }
00107 
00108 // @}
00109 
00110 #endif // LINALGPACK_OPTIONS_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines