RTOp_ROp_max_inequ_viol.h

Go to the documentation of this file.

/*
// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER
*/

#ifndef RTOP_ROP_MAX_INEQU_VIOL_H
#define RTOP_ROP_MAX_INEQU_VIOL_H

#include "RTOp.h"

#ifdef __cplusplus
extern "C" {
#endif


/* */
struct RTOp_ROp_max_inequ_viol_reduct_obj_t {
  RTOp_value_type   max_viol;   /*< <tt>max_viol = |v_i-vLU|/(1.0+|v_i|) > 0</tt> */
  RTOp_value_type   v_i;        /*< <tt>v_i = v(max_viol_i)</tt> */
  RTOp_value_type   vLU_i;      /*< <tt>vLU_i = vL(i)</tt> or <tt>vU(i)</tt> */
  RTOp_index_type   max_viol_i; /*< <tt>max_viol_i > 0</tt> if a inequality is violated */
  RTOp_index_type   bnd_type;   /*< -1 : LOWER, 0 : EQUALITY, +1 : UPPER */
};

/* Virtual function table */
extern const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_inequ_viol_vtbl;

/* Constructor */
int RTOp_ROp_max_inequ_viol_construct( struct RTOp_RTOp* op );

/* Destructor */
int RTOp_ROp_max_inequ_viol_destroy( struct RTOp_RTOp* op );

/* Extract the concrete reduction target object from its pointer (handle). */
struct RTOp_ROp_max_inequ_viol_reduct_obj_t
RTOp_ROp_max_inequ_viol_val(RTOp_ReductTarget targ_obj);

#ifdef __cplusplus
}
#endif

#endif  /* RTOP_ROP_MAX_INEQU_VIOL_H */