MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_ROp_norms.h
Go to the documentation of this file.
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00006 //                  Copyright (2003) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #ifndef RTOP_ROP_NORMS_H
00045 #define RTOP_ROP_NORMS_H
00046 
00047 #include "RTOp.h"
00048 
00049 #ifdef __cplusplus
00050 extern "C" {
00051 #endif
00052 
00061 /* Virtual function table */
00062 extern const struct RTOp_RTOp_vtbl_t RTOp_ROp_norm_1_vtbl;
00063 
00064 /* Constructor */
00065 int RTOp_ROp_norm_1_construct( struct RTOp_RTOp* op );
00066 
00067 /* Extract the value of the norm */
00068 RTOp_value_type RTOp_ROp_norm_1_val(RTOp_ReductTarget targ_obj);
00069 
00075 /* Virtual function table */
00076 extern const struct RTOp_RTOp_vtbl_t RTOp_ROp_norm_2_vtbl;
00077 
00078 /* Constructor */
00079 int RTOp_ROp_norm_2_construct( struct RTOp_RTOp* op );
00080 
00081 /* Extract the value of the norm */
00082 RTOp_value_type RTOp_ROp_norm_2_val(RTOp_ReductTarget targ_obj);
00083 
00089 /* Virtual function table */
00090 extern const struct RTOp_RTOp_vtbl_t RTOp_ROp_norm_inf_vtbl;
00091 
00092 /* Constructor */
00093 int RTOp_ROp_norm_inf_construct( struct RTOp_RTOp* op );
00094 
00095 /* Extract the value of the norm */
00096 RTOp_value_type RTOp_ROp_norm_inf_val(RTOp_ReductTarget targ_obj);
00097 
00098 /* Destructor (for all three norms) */
00099 int RTOp_ROp_norm_destroy( struct RTOp_RTOp* op );
00100 
00101 #ifdef __cplusplus
00102 }
00103 #endif
00104 
00105 #endif  /* RTOP_ROP_NORMS_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines