PEXSI
 All Classes Namespaces Files Functions Variables Typedefs Pages
NumTns.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_NUMTNS_HPP_
47 #define _PEXSI_NUMTNS_HPP_
48 
49 #include "environment.hpp"
50 #include "NumMat.hpp"
51 
52 
53 namespace PEXSI{
54 
62  template <class F>
63  class NumTns
64  {
65  public:
67  Int m_;
68 
70  Int n_;
71 
73  Int p_;
74 
76  bool owndata_;
77 
79  F* data_;
80  public:
81  NumTns(Int m=0, Int n=0, Int p=0);
82  NumTns(Int m, Int n, Int p, bool owndata, F* data);
83  NumTns(const NumTns& C);
84  ~NumTns();
85  NumTns& operator=(const NumTns& C);
86  void Resize(Int m, Int n, Int p);
87  const F& operator()(Int i, Int j, Int k) const;
88  F& operator()(Int i, Int j, Int k);
89  F* Data() const { return data_; }
90  F* MatData (Int j) const;
91  F* VecData (Int j, Int k) const;
92 
93  Int m() const { return m_; }
94  Int n() const { return n_; }
95  Int p() const { return p_; }
96  Int ByteSize() const { return p_*m_*n_*sizeof(F);}
97 
98  };
99 
100 
101  typedef NumTns<bool> BolNumTns;
102  typedef NumTns<Int> IntNumTns;
103  typedef NumTns<Real> DblNumTns;
104  typedef NumTns<Complex> CpxNumTns;
105 
106  // *********************************************************************
107  // Utility functions
108  // *********************************************************************
110  template <class F> inline void SetValue(NumTns<F>& T, F val);
111 
113  template <class F> inline Real Energy(const NumTns<F>& T);
114 
115 } // namespace PEXSI
116 
117 #include "NumTns_impl.hpp"
118 
119 #endif // _PEXSI_NUMTNS_HPP_
Environmental variables.
Int n_
The size of second dimension.
Definition: NumTns.hpp:70
Int m_
The size of the first dimension.
Definition: NumTns.hpp:67
Real Energy(const NumMat< F > &M)
Energy computes the L2 norm of a matrix (treated as a vector).
Definition: NumMat_impl.hpp:142
bool owndata_
Whether it owns the data.
Definition: NumTns.hpp:76
void SetValue(NumMat< F > &M, F val)
SetValue sets a numerical matrix to a constant val.
Definition: NumMat_impl.hpp:137
Numerical tensor.
Definition: NumTns.hpp:63
Implementation of numerical tensor.
Numerical matrix.
F * data_
The pointer for the actual data.
Definition: NumTns.hpp:79
Int p_
The size of third dimension.
Definition: NumTns.hpp:73