AnalysisObject.h

Go to the documentation of this file.

// -*- C++ -*-
//
// This file is part of YODA -- Yet more Objects for Data Analysis
// Copyright (C) 2008-2025 The YODA collaboration (see AUTHORS for details)
//
#ifndef YODA_AnalysisObject_h
#define YODA_AnalysisObject_h
 
#include "YODA/Exceptions.h"
#include "YODA/Utils/StringUtils.h"
#include "YODA/Config/BuildConfig.h"
 
#ifdef HAVE_HDF5
#include "YODA/Utils/H5Utils.h"
#endif
 
#include <iomanip>
#include <string>
#include <limits>
#include <map>
 
namespace YODA {
 
 
  class AnalysisObject {
 
  public:
 
    typedef std::map<std::string, std::string> Annotations;
 
 
 
    AnalysisObject() { }
 
    AnalysisObject(const std::string& type, const std::string& path, const std::string& title="") {
      setAnnotation("Type", type);
      setPath(path);
      setTitle(title);
    }
 
    AnalysisObject(const std::string& type, const std::string& path,
                   const AnalysisObject& ao, const std::string& title="") {
      AnalysisObject::operator = (ao);
      setAnnotation("Type", type); // might override the copied ones
      setPath(path);
      setTitle(title);
    }
 
    // /// Default copy constructor
    // AnalysisObject(const AnalysisObject& ao) {
    //   if (ao.path().length() > 0) setPath(ao.path());
    //   if (ao.title().length() > 0) setTitle(ao.title());
    // }
 
    virtual ~AnalysisObject() { }
 
    virtual AnalysisObject& operator = (const AnalysisObject& ao) noexcept {
      for (const std::string& a : ao.annotations()) {
        if (a == "Type")  continue;
        if (a == "Path"  && !ao.path().length())  continue;
        if (a == "Title" && !ao.title().length())  continue;
        setAnnotation(a, ao.annotation(a));
      }
      return *this;
    }
 
    virtual AnalysisObject* newclone() const = 0;
 
 
 
 
 
    virtual void reset() = 0;
 
 
 
    virtual void _renderYODA(std::ostream& os, const int width = 13) const noexcept = 0;
 
    virtual void _renderFLAT(std::ostream& os, const int width = 13) const noexcept = 0;
 
    #ifdef HAVE_HDF5
 
    virtual void _extractLabels(std::vector<std::string>&, std::vector<size_t>&) const noexcept { };
 
    virtual void _extractEdges(std::map<std::string, EdgeHandlerBasePtr>&,
                               const std::vector<std::string>&) const noexcept { };
 
    #endif
 
    virtual std::string _config() const noexcept { return ""; }
 
 
 
 
 
    std::vector<std::string> annotations() const {
      std::vector<std::string> rtn;
      rtn.reserve(_annotations.size());
      for (const Annotations::value_type& kv : _annotations) rtn.push_back(kv.first);
      return rtn;
    }
 
 
    bool hasAnnotation(const std::string& name) const {
      return _annotations.find(name) != _annotations.end();
    }
 
 
    const std::string& annotation(const std::string& name) const {
      Annotations::const_iterator v = _annotations.find(name);
      // If not found... written this way round on purpose
      if (v == _annotations.end()) {
        std::string missing = "YODA::AnalysisObject: No annotation named " + name;
        throw AnnotationError(missing);
      }
      return v->second;
    }
 
 
    const std::string& annotation(const std::string& name, const std::string& defaultreturn) const {
      Annotations::const_iterator v = _annotations.find(name);
      if (v != _annotations.end()) return v->second;
      return defaultreturn;
    }
 
 
    template <typename T>
    const T annotation(const std::string& name) const {
      std::string s = annotation(name);
      return Utils::lexical_cast<T>(s);
    }
 
 
    template <typename T>
    const T annotation(const std::string& name, const T& defaultreturn) const {
      Annotations::const_iterator v = _annotations.find(name);
      if (v != _annotations.end()) return Utils::lexical_cast<T>(v->second);
      return defaultreturn;
    }
 
 
    template <typename T>
    void setAnnotation(const std::string& name, const T& value) {
      if constexpr( std::is_floating_point<T>::value ) {
        // Recipe from Boost docs
        std::stringstream ss;
        ss << std::setprecision(std::numeric_limits<double>::max_digits10) << std::scientific << value;
        setAnnotation(name, ss.str());
      }
      else if constexpr( std::is_same<T, std::string>::value ) {
        _annotations[name] = value;
      }
      else {
        _annotations[name] = Utils::lexical_cast<std::string>(value);
      }
    }
 
 
    void setAnnotations(const Annotations& anns) {
      _annotations = anns;
    }
 
 
    template <typename T>
    void addAnnotation(const std::string& name, const T& value) {
      setAnnotation(name, value);
    }
 
 
    void rmAnnotation(const std::string& name) {
      _annotations.erase(name);
    }
 
 
    void clearAnnotations() {
      _annotations.clear();
    }
 
 
 
 
    const std::string title() const {
      return annotation("Title", "");
    }
 
    void setTitle(const std::string& title) {
      setAnnotation("Title", title);
    }
 
    const std::string path() const {
      const std::string p = annotation("Path", "");
      // If not set at all, return an empty string
      if (p.empty()) return p;
      // If missing a leading slash, one will be prepended
      return p.find("/") == 0 ? p : ("/"+p);
    }
 
    void setPath(const std::string& path) {
      const std::string p = (path.find("/") == 0) ? path : "/"+path;
      // if (path.length() > 0 && path.find("/") != 0) {
      //   throw AnnotationError("Histo paths must start with a slash (/) character.");
      // }
      setAnnotation("Path", p);
    }
 
 
    const std::string name() const {
      const std::string p = path();
      const size_t lastslash = p.rfind("/");
      if (lastslash == std::string::npos) return p;
      return p.substr(lastslash+1);
    }
 
 
 
  public:
 
 
    virtual std::string type() const {
      return annotation("Type");
    }
 
    virtual size_t dim() const noexcept = 0;
 
    virtual AnalysisObject* mkInert(const std::string& path = "",
                                    const std::string& source = "") const noexcept {
      (void)source;
      AnalysisObject* rtn = this->newclone();
      rtn->setPath(path);
      return rtn;
    }
 
 
 
    virtual size_t lengthContent(bool fixed_length = false) const noexcept = 0;
 
    virtual std::vector<double> serializeContent(bool fixed_length = false) const noexcept = 0;
 
    virtual void deserializeContent(const std::vector<double>& data) = 0;
 
    size_t lengthMeta(const bool skipPath = true,
                      const bool skipTitle = true) const noexcept {
      return 2*(_annotations.size() - skipPath - skipTitle);
    }
 
    std::vector<std::string> serializeMeta(const bool skipPath = true,
                                           const bool skipTitle = true) const noexcept {
 
      // Assemble annotations
      std::vector<std::string> rtn;
      rtn.reserve(2*(_annotations.size() - skipPath - skipTitle));
      for (const auto& item : _annotations) {
        if (item.first == "Type")  continue;
        if (skipPath && item.first == "Path")  continue;
        if (skipTitle && item.first == "Title")  continue;
        rtn.push_back(item.first);
        rtn.push_back(item.second);
      }
      return rtn;
    }
 
    virtual void deserializeMeta(const std::vector<std::string>& data,
                                 const bool resetPath = false, const bool resetTitle = false) {
 
      if (data.empty())  return;
      if (data.size() % 2)
        throw  UserError("Expected even number of annotation elements (key-value pairs)!");
 
      const std::string path = annotation("Path");
      const std::string type = annotation("Type");
      const std::string title = annotation("Title");
      _annotations.clear();
      _annotations["Type"] = type;
      if (!resetPath)   _annotations["Path"] = path;
      if (!resetTitle)  _annotations["Title"] = title;
 
      auto itr = data.cbegin();
      const auto itrEnd = data.cend();
      while (itr != itrEnd) {
        const std::string key = *itr; ++itr;
        const std::string val = *itr; ++itr;
        _annotations[key] = val;
      }
    }
 
 
  private:
 
    std::map<std::string,std::string> _annotations;
 
  };
 
 
  using AO = AnalysisObject;
 
 
}
 
#endif // YODA_AnalysisObject_h