AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_sparse_bounds.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef SPARSE_LIN_ALG_PACK_SPARSE_BOUNDS_H
43 #define SPARSE_LIN_ALG_PACK_SPARSE_BOUNDS_H
44 
45 #include "DenseLinAlgPack_DVectorClass.hpp"
46 
47 namespace AbstractLinAlgPack {
48 
56 private:
57  enum EBound { LOWER, UPPER, BOTH };
58 public:
59 
62  const DVectorSlice::const_iterator &bl_begin
63  ,const DVectorSlice::const_iterator &bl_end
64  ,const DVectorSlice::const_iterator &bu_begin
65  ,const DVectorSlice::const_iterator &bu_end
66  ,value_type big_bnd
67  )
68  :bl_itr_(bl_begin), bl_end_(bl_end), bu_itr_(bu_begin), bu_end_(bu_end)
69  ,big_bnd_(big_bnd), index_(1)
70  {
71  if( !at_end() && ( *bl_itr_ <= -big_bnd_ && +big_bnd_ <= *bu_itr_ ) )
72  this->operator++();
73  else
74  update();
75  }
77  const value_type& big_bnd() const
78  { return big_bnd_; }
80  bool at_end() const
81  { return bl_itr_ == bl_end_; }
84  if(!at_end()) { ++bl_itr_; ++bu_itr_; ++index_; }
85  for( ; !at_end() && ( *bl_itr_ <= -big_bnd_ && +big_bnd_ <= *bu_itr_ )
86  ; ++bl_itr_, ++bu_itr_, ++index_ );
87  update();
88  return *this;
89  }
91  index_type index() const
92  { return index_; }
94  value_type lbound() const
95  { return lbound_; }
97  value_type ubound() const
98  { return ubound_; }
99 
100 private:
101  DVectorSlice::const_iterator
102  bl_itr_, bl_end_, bu_itr_, bu_end_;
103  value_type
104  big_bnd_, lbound_, ubound_;
105  index_type
106  index_;
107  EBound
108  at_bound_;
109 
110  void update() {
111  if( bl_itr_ == bl_end_ ) {
112  return;
113  }
114  else if( -big_bnd_ < *bl_itr_ && *bu_itr_ < +big_bnd_ ) {
115  lbound_ = *bl_itr_;
116  ubound_ = *bu_itr_;
117  at_bound_ = BOTH;
118  }
119  else if( -big_bnd_ < *bl_itr_ ) {
120  lbound_ = *bl_itr_;
121  ubound_ = +big_bnd_;
122  at_bound_ = LOWER;
123  }
124  else if( *bu_itr_ < +big_bnd_ ) {
125  lbound_ = -big_bnd_;
126  ubound_ = *bu_itr_;
127  at_bound_ = UPPER;
128  }
129  }
130 
131  // not defined and not to be called
133 
134 }; // end class sparse_bounds_itr
135 
136 } // end namespace AbstractLinAlgPack
137 
138 #endif // SPARSE_LIN_ALG_PACK_SPARSE_BOUNDS_H
Iterate through a set of sparse bounds.
sparse_bounds_itr(const DVectorSlice::const_iterator &bl_begin, const DVectorSlice::const_iterator &bl_end, const DVectorSlice::const_iterator &bu_begin, const DVectorSlice::const_iterator &bu_end, value_type big_bnd)