include/Geant4/G4MemStat.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // Author: Mathieu Karamitros
0027
0028 // The code is developed in the framework of the ESA AO7146
0029 //
0030 // We would be very happy hearing from you, send us your feedback! :)
0031 //
0032 // In order for Geant4-DNA to be maintained and still open-source,
0033 // article citations are crucial.
0034 // If you use Geant4-DNA chemistry and you publish papers about your software,
0035 // in addition to the general paper on Geant4-DNA:
0036 //
0037 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0038 //
0039 // we would be very happy if you could please also cite the following
0040 // reference papers on chemistry:
0041 //
0042 // J. Comput. Phys. 274 (2014) 841-882
0043 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0044
0045 #ifndef G4MEMSTAT_HH_
0046 #define G4MEMSTAT_HH_
0047
0048 #include "globals.hh"
0049
0050 namespace G4MemStat
0051 {
0052
0053     struct MemStat;
0054
0055     std::ostream & operator<<(std::ostream &os, const MemStat& p);
0056
0057     struct MemStat
0058     {
0059
0060         friend std::ostream & operator<<(std::ostream &os, const MemStat& p);
0061         double vmz{0};
0062         double mem{0};
0063
0064         MemStat()= default;
0065         MemStat(const MemStat& right)
0066         {
0067             vmz = right.vmz;
0068             mem = right.mem;
0069         }
0070
0071         MemStat operator-(const MemStat& right)
0072         {
0073             MemStat output;
0074             output.vmz = this->vmz-right.vmz;
0075             output.mem = this->mem-right.mem;
0076             return output;
0077         }
0078     };
0079
0080     MemStat MemoryUsage();
0081
0082     std::ostream & operator<<(std::ostream &os, const MemStat& p);
0083 }
0084 #endif /* MEMSTAT_HH_ */