MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_sparse_bounds.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 #ifndef SPARSE_LIN_ALG_PACK_SPARSE_BOUNDS_H
00043 #define SPARSE_LIN_ALG_PACK_SPARSE_BOUNDS_H
00044 
00045 #include "DenseLinAlgPack_DVectorClass.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00055 class sparse_bounds_itr {
00056 private:
00057   enum EBound { LOWER, UPPER, BOTH };
00058 public:
00059 
00061   sparse_bounds_itr(  
00062     const DVectorSlice::const_iterator   &bl_begin
00063     ,const DVectorSlice::const_iterator  &bl_end
00064     ,const DVectorSlice::const_iterator  &bu_begin
00065     ,const DVectorSlice::const_iterator  &bu_end
00066     ,value_type                         big_bnd
00067     )
00068     :bl_itr_(bl_begin), bl_end_(bl_end), bu_itr_(bu_begin), bu_end_(bu_end)
00069     ,big_bnd_(big_bnd), index_(1)
00070   {
00071     if( !at_end() && ( *bl_itr_ <= -big_bnd_ && +big_bnd_ <= *bu_itr_ ) )
00072       this->operator++();
00073     else
00074       update();
00075   }
00077   const value_type& big_bnd() const
00078   {    return big_bnd_; }
00080   bool at_end() const
00081   { return bl_itr_ == bl_end_; }
00083   sparse_bounds_itr& operator++() {
00084     if(!at_end()) { ++bl_itr_; ++bu_itr_; ++index_; }
00085     for( ; !at_end() && ( *bl_itr_ <= -big_bnd_ && +big_bnd_ <= *bu_itr_ )
00086        ; ++bl_itr_, ++bu_itr_, ++index_ );
00087     update();
00088     return *this;
00089   }
00091   index_type index() const
00092   { return index_; }
00094   value_type lbound() const
00095   { return lbound_; }
00097   value_type ubound() const
00098   { return ubound_; }
00099 
00100 private:
00101   DVectorSlice::const_iterator
00102     bl_itr_, bl_end_, bu_itr_, bu_end_;
00103   value_type
00104     big_bnd_, lbound_, ubound_;
00105   index_type
00106     index_;
00107   EBound
00108     at_bound_;
00109 
00110   void update() {
00111     if( bl_itr_ == bl_end_ ) {
00112       return;
00113     }
00114     else if( -big_bnd_ < *bl_itr_ && *bu_itr_ < +big_bnd_ ) {
00115       lbound_ = *bl_itr_;
00116       ubound_ = *bu_itr_;
00117       at_bound_ = BOTH;
00118     }
00119     else if( -big_bnd_ < *bl_itr_ ) {
00120       lbound_ = *bl_itr_;
00121       ubound_ = +big_bnd_;
00122       at_bound_ = LOWER;
00123     }
00124     else if( *bu_itr_ < +big_bnd_ ) {
00125       lbound_ = -big_bnd_;
00126       ubound_ = *bu_itr_;
00127       at_bound_ = UPPER;
00128     }
00129   }
00130 
00131   // not defined and not to be called
00132   sparse_bounds_itr();
00133 
00134 };  // end class sparse_bounds_itr
00135 
00136 } // end namespace AbstractLinAlgPack
00137 
00138 #endif // SPARSE_LIN_ALG_PACK_SPARSE_BOUNDS_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines