source: trunk/source/materials/include/G4MaterialPropertyVector.hh @ 1294

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
// $Id: G4MaterialPropertyVector.hh,v 1.14 2009/04/24 09:35:14 gcosmo Exp $
// GEANT4 tag $Name: materials-V09-02-18 $
//
// 
////////////////////////////////////////////////////////////////////////
//
// class G4MaterialPropertyVector
//
// Class description:
//
// A one-to-one mapping from Photon Energy to some optical property 

// File:        G4MaterialPropertyVector.hh
//
// Version:     1.0
// Created:     1996-02-08
// Author:      Juliet Armstrong
// Updated:     1999-10-29 add method and class descriptors
//              1997-03-25 by Peter Gumplinger
//              > value.h -> templates.hh
// mail:        gum@triumf.ca
//
////////////////////////////////////////////////////////////////////////

#ifndef G4MaterialPropertyVector_h   
#define G4MaterialPropertyVector_h 1

/////////////
// Includes
/////////////

#include "G4MPVEntry.hh"
#include <vector>
#include <functional>

/////////////////////
// Class Definition
/////////////////////

class G4MaterialPropertyVector
{
  struct MPVEntry_less
    : public std::binary_function<G4MPVEntry*, G4MPVEntry*, G4bool>
  {
    G4bool operator()(G4MPVEntry* x, G4MPVEntry* y) { return *x < *y; }
  };

  public: // Without description

    //////////////
    // Operators
    //////////////

    inline G4bool operator ++();
    G4MaterialPropertyVector& operator =(const G4MaterialPropertyVector &right);

    /////////////////
    // Constructors
    /////////////////

    G4MaterialPropertyVector() : MPV(0) 
    {
      CurrentEntry = -1;
      NumEntries   = 0;
    };

  public: // With description
  
    G4MaterialPropertyVector(G4double *PhotonEnergies, 
                             G4double *PropertyValues,
                             G4int     NumElements);
      // Constructor of G4MaterialPropertyVector object.

    inline void ResetIterator();
    inline G4int Entries() const;

    inline void AddElement(G4double aPhotonEnergy, G4double aPropertyValue);
      // Add a new element (pair of numbers) to the G4MaterialPropertyVector.
    void RemoveElement(G4double aPhotonEnergy);
      // Remove the element with given x-value.

    G4double GetProperty(G4double aPhotonEnergy) const;
      // Returns the y-value for given x-value (with interpolation).
    G4double GetPhotonEnergy(G4double aProperty) const;
      // Returns the x-value for given y-value (with interpolation).
      // NOTE: Assumes that the y-value is an increasing function of 
      //       the x-value. Returns the x-value corresponding to the 
      //       y-value passed in. If several x-values correspond to 
      //       the y-value passed in, the method returns the first 
      //       x-value in the vector that corresponds to that value.
      // For use with G4MaterialPropertyVector iterator: return
      // property (or Photon Energy) at current point of iterator.

    inline G4double GetProperty() const;
    inline G4double GetPhotonEnergy() const;
    inline G4double GetMaxProperty() const;
    inline G4double GetMinProperty() const;
    inline G4double GetMaxPhotonEnergy() const;
    inline G4double GetMinPhotonEnergy() const;
    
  public: // Without description

    G4MaterialPropertyVector(const G4MaterialPropertyVector &right);
   ~G4MaterialPropertyVector();

    //////////
    // Tests
    //////////

    void DumpVector();

    /////////////////////
    // Helper Functions
    /////////////////////

    inline G4MPVEntry GetEntry(G4int i) const;

  private:

    void GetAdjacentBins(G4double aPhotonEnergy,
                         G4int *left, G4int *right) const;

  private:

    /////////////////////////
    // Private Data Members
    /////////////////////////

    std::vector<G4MPVEntry*> MPV;
    G4int NumEntries;
    G4int CurrentEntry;
};

///////////////////
// Inline methods
///////////////////

#include "G4MaterialPropertyVector.icc"

#endif /* G4MaterialPropertyVector_h */