MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ConstrainedOptPack_print_vector_change_stats.cpp
Go to the documentation of this file.
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 
44 
46  const DVectorSlice& x, const char x_name[]
47  , const DVectorSlice& d, const char d_name[], std::ostream& out )
48 {
49  value_type max_term, min_term, av_term;
50  size_type max_k, min_k;
52  x, d
53  , &max_term, &max_k
54  , &min_term, &min_k
55  , &av_term );
56  out << "\nmax(|"<<d_name<<"(i)|/(1+|"<<x_name<<"(i)|)"
57  << " => |"<<d_name<<"("<<max_k<<")|/(1+|"<<x_name<<"("<<max_k<<")| = "<< max_term
58  << "\nmin(|"<<d_name<<"(i)|/(1+|"<<x_name<<"(i)|)"
59  << " => |"<<d_name<<"("<<min_k<<")|/(1+|"<<x_name<<"("<<min_k<<")| = "<< min_term
60  << "\naverage(|"<<d_name<<"(i)|/(1+|"<<x_name<<"(i)|) = " << av_term << std::endl;
61 }
void vector_change_stats(const DVectorSlice &x, const DVectorSlice &d, value_type *max_term, size_type *max_k, value_type *min_term, size_type *min_k, value_type *av_term)
Compute statistics for change in a vector.
AbstractLinAlgPack::size_type size_type
const std::string x_name
void print_vector_change_stats(const DVectorSlice &x, const char x_name[], const DVectorSlice &d, const char d_name[], std::ostream &out)
Compute statistics for change in a vector and output to a stream.
std::ostream * out
DenseLinAlgPack::VectorSliceTmpl< value_type > DVectorSlice
AbstractLinAlgPack::value_type value_type
const std::string d_name