NumTns.hpp

Go to the documentation of this file.

/*
         Copyright (c) 2012 The Regents of the University of California,
         through Lawrence Berkeley National Laboratory.  

   Authors: Lexing Ying, Mathias Jacquelin and Lin Lin
         
   This file is part of PEXSI. All rights reserved.

         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:

         (1) Redistributions of source code must retain the above copyright notice, this
         list of conditions and the following disclaimer.
         (2) Redistributions in binary form must reproduce the above copyright notice,
         this list of conditions and the following disclaimer in the documentation
         and/or other materials provided with the distribution.
         (3) Neither the name of the University of California, Lawrence Berkeley
         National Laboratory, U.S. Dept. of Energy nor the names of its contributors may
         be used to endorse or promote products derived from this software without
         specific prior written permission.

         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
         ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
         WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
         ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
         (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
         LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
         ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
         (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
         SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

         You are under no obligation whatsoever to provide any bug fixes, patches, or
         upgrades to the features, functionality or performance of the source code
         ("Enhancements") to anyone; however, if you choose to make your Enhancements
         available either publicly, or directly to Lawrence Berkeley National
         Laboratory, without imposing a separate written license agreement for such
         Enhancements, then you hereby grant the following license: a non-exclusive,
         royalty-free perpetual license to install, use, modify, prepare derivative
         works, incorporate into other computer software, distribute, and sublicense
         such enhancements or derivative works thereof, in binary and source code form.
*/
#ifndef _PEXSI_NUMTNS_HPP_
#define _PEXSI_NUMTNS_HPP_

#include "environment.hpp"
#include "NumMat.hpp"


namespace  PEXSI{

        template <class F>
                class NumTns
                {
                public:
                        Int m_; 

                        Int n_; 

                        Int p_;

                        bool owndata_;

                        F* data_;
                public:
                        NumTns(Int m=0, Int n=0, Int p=0);
                        NumTns(Int m, Int n, Int p, bool owndata, F* data);
                        NumTns(const NumTns& C);
                        ~NumTns();
                        NumTns& operator=(const NumTns& C);
                        void Resize(Int m, Int n, Int p);
                        const F& operator()(Int i, Int j, Int k) const;
                        F& operator()(Int i, Int j, Int k);
                        F* Data() const { return data_; }
                        F* MatData (Int j) const;
                        F* VecData (Int j, Int k) const;

                        Int m() const { return m_; }
                        Int n() const { return n_; }
                        Int p() const { return p_; }
      Int ByteSize() const { return p_*m_*n_*sizeof(F);}

                };


        typedef NumTns<bool>       BolNumTns;
        typedef NumTns<Int>        IntNumTns;
        typedef NumTns<Real>       DblNumTns;
        typedef NumTns<Complex>    CpxNumTns;

        // *********************************************************************
        // Utility functions
        // *********************************************************************
        template <class F> inline void SetValue(NumTns<F>& T, F val);

        template <class F> inline Real Energy(const NumTns<F>& T);

} // namespace PEXSI

#include "NumTns_impl.hpp"

#endif // _PEXSI_NUMTNS_HPP_