CrystalFp.h

Go to the documentation of this file.

#ifndef CRYSTALFP_H
#define CRYSTALFP_H

#ifdef _MSC_VER
#pragma warning(disable:4786)
#endif
#include <vector>
#include <set>
#include <string>
#include <climits>
#include "CrystalFpExceptions.h"

namespace cfp
{
class CrystalFp
{
public:
    //###################################################################################


    CrystalFp(unsigned int aVerboseLevel);

    ~CrystalFp();

    void resetAll(void);



    //###################################################################################


    const std::vector<std::string> getFingerprintMethodsNames(void) const;

    const std::vector<std::string> getDistanceMethodsNames(void) const;

    const std::vector<std::string> getGroupingMethodsNames(void) const;



    //###################################################################################


    void            addStructure(int aStep, unsigned int aNumAtoms, const float *aCoords, const unsigned int *aZ, const float *aUnitCell, bool aHasEnergy=false, float aEnergy=0.0F, bool aEnergyIsPerAtom=true);

    void            addStructureBatch(int aStep, unsigned int aNumAtoms, const float *aCoords, const unsigned int *aZ, const float *aUnitCell, bool aHasEnergy=false, float aEnergy=0.0F, bool aEnergyIsPerAtom=true);

    void            addStructureBatchFinish(void);

    size_t          getNumActiveStructures(void) const;

    size_t          getNumTotalStructures(void) const;



    //###################################################################################


    void            energyThreshold(float aEnergyThreshold);

    void            noEnergyThreshold(void);


    
    //###################################################################################


    bool            hasEnergies(void) const;

    float           getMinEnergy(void) const;
    
    bool            hasUnitCell(void) const;



    //###################################################################################


    int             idxToStep(size_t aIdx) const;

    float           getTotalEnergy(size_t aIdx) const;

    float           getPerAtomEnergy(size_t aIdx) const;
    
    unsigned int    getNatoms(size_t aIdx) const;

    const float*    getUnitCell(size_t aIdx) const;
    
    const unsigned int* getAtomZ(size_t aIdx) const;

    const float*    getCoords(size_t aIdx) const;



    //###################################################################################


    float           computeCutoffDistance(float aMargin=0.02F) const;

    void            setFingerprintMethod(unsigned int aFingerprintType);

    bool            isDiffractionLike(void) const;

    const std::string getFingerprintMethod(void) const;

    void            setCutoffDistance(float aCutoff);

    void            setNanoclusterStructureType(void);

    void            setDiffrBinSize(float aBinSize);

    void            setDiffrPeakSize(float aPeakSize);

    void            forceFpLength(unsigned int aDim);

    void            setCheckpointDir(const char* aDir);

    void            loadCheckpoint(void);

    void            computeFingerprints(void);

    unsigned int    getFingerprintNumSections(void) const;

    unsigned int    getFingerprintSectionLen(void) const;

    bool            hasFingerprints(void) const;

    float           getCutoffDistance(void) const;

    const float*    getFingerprint(size_t aStructureIdx) const;

    float           getDiffrPeakSize(void) const;

    float           getDiffrBinSize(void) const;

    const std::vector< std::vector<float> >& getInteratomicDistances(unsigned int aIdx) const;
    
    const float*    getWeights(size_t aIdx) const;


    
    //###################################################################################


    void            setDistanceMethod(unsigned int aMeasureType);

    const std::string getDistanceMethod(void) const;

    void            computeDistanceMatrix(void);

    bool            hasDistanceMatrix(void) const;

    float           getDistance(size_t aIdx1, size_t aIdx2) const;

    float           getMaxDistance(void) const;



    //###################################################################################


    void            setGroupingMethod(unsigned int aGroupingMethod);

    const std::string getGroupingMethod(void) const;

    void            groupResults(void);

    void            setMaxGroupingDistance(float aMaxDistance);

    float           getMaxGroupingDistance(void) const;

    void            setK(unsigned int aK);

    unsigned int    getNgroups(void) const;

    const std::vector< std::set<unsigned int> >& getGroups(void) const;

    unsigned int    getNsingle(void) const;

    bool            groupingNeedsK(void) const;

    unsigned int    reduceDuplicatesToRepresentative(std::vector<unsigned int>& aNewIndexList);



    //###################################################################################


    void serialize(std::ofstream& aStream) const;

    void unserialize(std::ifstream& aStream, bool aAppend=false, int aStepOffset=10000);


    //###################################################################################


    void dump(void) const;

private:
    CrystalFp(const CrystalFp&);
    CrystalFp& operator=(const CrystalFp&);

private:
    static void unitCellInverse(const float *aUnitCell, float aUnitCellInverse[3][3]);
    void computeExpansion(const float* aUnitCell, unsigned int* aExpansion) const;

private:
    struct CrystalFpImpl;
    struct CrystalFpImpl* mPimpl;
};

}

#endif