PEXSI
 All Classes Namespaces Files Functions Variables Typedefs Pages
NumVec.hpp
Go to the documentation of this file.
1 /*
2  Copyright (c) 2012 The Regents of the University of California,
3  through Lawrence Berkeley National Laboratory.
4 
5 Authors: Lexing Ying, Mathias Jacquelin and Lin Lin
6 
7 This file is part of PEXSI. All rights reserved.
8 
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are met:
11 
12 (1) Redistributions of source code must retain the above copyright notice, this
13 list of conditions and the following disclaimer.
14 (2) Redistributions in binary form must reproduce the above copyright notice,
15 this list of conditions and the following disclaimer in the documentation
16 and/or other materials provided with the distribution.
17 (3) Neither the name of the University of California, Lawrence Berkeley
18 National Laboratory, U.S. Dept. of Energy nor the names of its contributors may
19 be used to endorse or promote products derived from this software without
20 specific prior written permission.
21 
22 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
23 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
26 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 
33 You are under no obligation whatsoever to provide any bug fixes, patches, or
34 upgrades to the features, functionality or performance of the source code
35 ("Enhancements") to anyone; however, if you choose to make your Enhancements
36 available either publicly, or directly to Lawrence Berkeley National
37 Laboratory, without imposing a separate written license agreement for such
38 Enhancements, then you hereby grant the following license: a non-exclusive,
39 royalty-free perpetual license to install, use, modify, prepare derivative
40 works, incorporate into other computer software, distribute, and sublicense
41 such enhancements or derivative works thereof, in binary and source code form.
42  */
46 #ifndef _PEXSI_NUMVEC_HPP_
47 #define _PEXSI_NUMVEC_HPP_
48 
49 #include "pexsi/environment.hpp"
50 
51 namespace PEXSI{
60 template <class F> class NumVec
61 {
62 protected:
63 
65  inline void allocate(F* data=NULL);
66 
68  inline void deallocate();
69 
71  Int m_;
74  bool owndata_;
75 
77  F* data_;
78 
80  Int bufsize_;
81 public:
82  NumVec();
83  NumVec(Int m);
84  NumVec(Int m, bool owndata, F* data);
85  NumVec(const NumVec& C);
86  ~NumVec();
87 
88  NumVec& operator=(const NumVec& C);
89 
90  void Resize ( Int m );
91  void Clear();
92 
93  const F& operator()(Int i) const;
94  F& operator()(Int i);
95  const F& operator[](Int i) const;
96  F& operator[](Int i);
97 
98  bool IsOwnData() const { return owndata_; }
99  F* Data() const { return data_; }
100  Int m () const { return m_; }
101  Int ByteSize() const { return m_*sizeof(F);}
102 };
103 
104 // Commonly used
105 typedef NumVec<bool> BolNumVec;
106 typedef NumVec<Int> IntNumVec;
107 typedef NumVec<Real> DblNumVec;
108 typedef NumVec<Complex> CpxNumVec;
109 
110 
111 // *********************************************************************
112 // Utility functions
113 // *********************************************************************
115 template <class F> inline void SetValue( NumVec<F>& vec, F val );
116 
118 template <class F> inline Real Energy( const NumVec<F>& vec );
119 
120 
121 } // namespace PEXSI
122 
123 #include "pexsi/NumVec_impl.hpp"
124 
125 #endif // _PEXSI_NUMVEC_HPP_
Numerical vector.
Definition: NumVec.hpp:60
Environmental variables.
void allocate(F *data=NULL)
Helper function allocating the memory pointed by the data_ attribute.
Definition: NumVec_impl.hpp:171
void deallocate()
Helper function freeing memory pointed by the data_ attribute.
Definition: NumVec_impl.hpp:192
Real Energy(const NumMat< F > &M)
Energy computes the L2 norm of a matrix (treated as a vector).
Definition: NumMat_impl.hpp:158
bool owndata_
Whether it owns the data.
Definition: NumVec.hpp:74
void SetValue(NumMat< F > &M, F val)
SetValue sets a numerical matrix to a constant val.
Definition: NumMat_impl.hpp:153
Implementation of Numerical Vector.
F * data_
The pointer for the actual data.
Definition: NumVec.hpp:77
Int bufsize_
The actual storage space allocated.
Definition: NumVec.hpp:80
Int m_
The size of the vector.
Definition: NumVec.hpp:71