EpetraExt  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GenSQP_Vector.hpp
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ***********************************************************************
4 //
5 // EpetraExt: Epetra Extended - Linear Algebra Services Package
6 // Copyright (2011) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ***********************************************************************
41 //@HEADER
42 */
43 
44 #ifndef GENSQP_VECTOR_H
45 #define GENSQP_VECTOR_H
46 
47 #include "Teuchos_RCP.hpp"
48 
60 namespace GenSQP {
61 
62 class Vector {
63 public:
64 
65  virtual ~Vector() {}
66 
69  virtual double innerProd( const Vector &x ) const = 0;
70 
73  virtual void linComb( const double &alpha, const Vector &x, const double &beta = 1.0 ) = 0;
74 
77  virtual void Scale( const double &alpha ) = 0;
78 
81  virtual void Set( const double &alpha ) = 0;
82 
85  virtual void Set( const double &alpha, const Vector &x ) = 0;
86 
89  virtual Teuchos::RCP<Vector> createVector() const = 0;
90 
91 }; // class Vector
92 
93 } // namespace GenSQP
94 
95 #endif
virtual void linComb(const double &alpha, const Vector &x, const double &beta=1.0)=0
y = alpha*x + beta*y where y == *this.
virtual Teuchos::RCP< Vector > createVector() const =0
Clone to make a new (uninitialized) vector.
Provides the interface to generic abstract vector libraries.
virtual void Scale(const double &alpha)=0
y = alpha*y where y == *this.
virtual double innerProd(const Vector &x) const =0
Returns inner(*this,x).
virtual void Set(const double &alpha)=0
y = alpha where y == *this.
virtual ~Vector()