AbstractLinAlgPack_VectorAuxiliaryOps.hpp

// @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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef ABSTRACT_LINALG_PACK_VECTOR_AUXILIARY_OPS_H
#define ABSTRACT_LINALG_PACK_VECTOR_AUXILIARY_OPS_H

#include <utility>

#include "AbstractLinAlgPack_VectorMutable.hpp"

namespace AbstractLinAlgPack {



value_type max_element( const Vector& v ); 

std::pair<value_type,value_type>
max_near_feas_step(
  const Vector& x, const Vector& d
  ,const Vector& xl, const Vector& xu
  ,value_type max_bnd_viol
  ); 

value_type max_rel_step(
  const Vector& x, const Vector& d
  );


value_type fraction_to_boundary(
  const value_type    tau,
  const Vector  &x,
  const Vector  &d,
  const Vector  &xl,
  const Vector  &xu
  );


value_type fraction_to_zero_boundary(
  const value_type    tau,
  const Vector  &x,
  const Vector  &d
  );

size_type num_bounded(
  const Vector& xl, const Vector& xu
  ,value_type inf_bound );

value_type log_bound_barrier(
  const Vector    &x
  ,const Vector   &xl
  ,const Vector   &xu
  ); 

value_type combined_nu_comp_err(
  const Vector    &v
  ,const Vector   &x
  ,const Vector   &xl
  ,const Vector   &xu
  ); 


value_type combined_nu_comp_err_lower(
  const Vector    &v
  ,const Vector    &x
  ,const Vector   &xl
  );

value_type combined_nu_comp_err_upper(
  const Vector    &v
  ,const Vector   &x
  ,const Vector   &xu
  );


value_type IP_comp_err_with_mu(
  const value_type    mu
  ,const value_type   inf_bound
  ,const Vector &x
  ,const Vector &xl
  ,const Vector &xu
  ,const Vector &vl
  ,const Vector &vu
  );

bool max_inequ_viol(
  const AbstractLinAlgPack::Vector   &v
  ,const AbstractLinAlgPack::Vector  &vL
  ,const AbstractLinAlgPack::Vector  &vU
  ,AbstractLinAlgPack::size_type     *max_viol_i
  ,AbstractLinAlgPack::value_type    *max_viol
  ,AbstractLinAlgPack::value_type    *v_i
  ,int                               *bnd_type
  ,AbstractLinAlgPack::value_type    *vLU_i
  ); 



void force_in_bounds( const Vector& xl, const Vector& xu, VectorMutable* x );

void force_in_bounds_buffer(
  const value_type     rel_push,
  const value_type     abs_push,
  const Vector   &xl, 
  const Vector   &xu, 
  VectorMutable  *x 
  );

void inv_of_difference(
  const value_type       alpha
  ,const Vector    &v0
  ,const Vector    &v1
  ,VectorMutable   *z
  );

void correct_lower_bound_multipliers(
  const Vector      &xl
  ,const value_type       inf_bound_limit
  ,VectorMutable    *vl
  );

void correct_upper_bound_multipliers(
  const Vector       &xu
  ,const value_type        inf_bound_limit
  ,VectorMutable     *vu
  );

void lowerbound_multipliers_step(
  const value_type         mu,
  const Vector       &invXl,
  const Vector       &vl,
  const Vector       &d_k,
  VectorMutable      *dvl
  );

void upperbound_multipliers_step(
  const value_type       mu,
  const Vector     &invXu,
  const Vector     &vu,
  const Vector     &d_k,
  VectorMutable    *dvu
  );


void ele_wise_sqrt(
  VectorMutable* z
    );    

void max_vec_scalar(
  value_type              min_ele
  ,VectorMutable    *y
  );

void max_abs_vec_scalar(
  value_type              min_ele
  ,VectorMutable    *y
  );



} // end namespace AbstractLinAlgPack

#endif // ABSTRACT_LINALG_PACK_VECTOR_AUXILIARY_OPS_H