RTOpPack: Extra C/C++ Code for Vector Reduction/Transformation Operators  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
RTOp_ROp_max_inequ_viol.h
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
6 // Copyright (2003) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #ifndef RTOP_ROP_MAX_INEQU_VIOL_H
45 #define RTOP_ROP_MAX_INEQU_VIOL_H
46 
47 #include "RTOp.h"
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
72 
74 /* */
78  RTOp_value_type max_viol; /*< <tt>max_viol = |v_i-vLU|/(1.0+|v_i|) > 0</tt> */
79  RTOp_value_type v_i; /*< <tt>v_i = v(max_viol_i)</tt> */
80  RTOp_value_type vLU_i; /*< <tt>vLU_i = vL(i)</tt> or <tt>vU(i)</tt> */
81  RTOp_index_type max_viol_i; /*< <tt>max_viol_i > 0</tt> if a inequality is violated */
82  RTOp_index_type bnd_type; /*< -1 : LOWER, 0 : EQUALITY, +1 : UPPER */
83 };
84 
85 /* Virtual function table */
86 extern const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_inequ_viol_vtbl;
87 
88 /* Constructor */
89 int RTOp_ROp_max_inequ_viol_construct( struct RTOp_RTOp* op );
90 
91 /* Destructor */
92 int RTOp_ROp_max_inequ_viol_destroy( struct RTOp_RTOp* op );
93 
94 /* Extract the concrete reduction target object from its pointer (handle). */
96 RTOp_ROp_max_inequ_viol_val(RTOp_ReductTarget targ_obj);
97 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 #endif /* RTOP_ROP_MAX_INEQU_VIOL_H */