InputSignature.h

Go to the documentation of this file.

/*
Copyright (C) 2024 Scott Grauer-Gray
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
*/
 
#ifndef INPUT_SIGNATURE_H_
#define INPUT_SIGNATURE_H_
 
#include <string_view>
#include <string>
#include <ostream>
#include <limits>
#include <optional>
#include "RunEval/RunEvalConstsEnums.h"
 
class InputSignature {
public:
  explicit InputSignature(const std::array<std::string_view, 3>& in_sig_strings);
 
  explicit InputSignature(
    std::optional<unsigned int> data_type_size,
    std::optional<unsigned int> eval_set_num,
    std::optional<bool> use_templated_loop_iters);
 
  bool operator<(const InputSignature& rhs) const;
 
  bool operator==(const InputSignature& rhs) const;
 
  bool EqualsUsingAny(const InputSignature& rhs) const;
 
  std::string DataTypeStr() const {
    if (!data_type_size_) {
      return "ANY";
    }
    if (*data_type_size_ == 2) {
      return "HALF";
    }
    else if (*data_type_size_ == 4) {
      return "FLOAT";
    }
    else if (*data_type_size_ == 8) {
      return "DOUBLE";
    }
    return "UNKNOWN";
  }
 
  std::string EvalSetNumStr() const {
    if (!eval_set_num_) {
      return "ANY";
    }
    else {
      return std::to_string(*eval_set_num_);
    }
  }
 
  unsigned int EvalSetNum() const {
    if (!eval_set_num_) {
      return std::numeric_limits<unsigned int>::max();
    }
    else {
      return *eval_set_num_;
    }
  }
 
  std::string UseTemplatedLoopItersStr() const {
    if (!use_templated_loop_iters_) {
      return "BOTH";
    }
    return ((!(*use_templated_loop_iters_)) ?
      std::string(run_eval::kBoolValFalseTrueDispStr[0]) :
      std::string(run_eval::kBoolValFalseTrueDispStr[1]));
  }
  
  void RemoveTemplatedLoopIterSetting() {
    use_templated_loop_iters_.reset();
  }
 
  void RemoveDatatypeSetting() {
    data_type_size_.reset();
  }
 
  std::optional<bool> TemplatedLoopIters() const {
    return use_templated_loop_iters_;
  }
 
  friend std::ostream& operator<<(
    std::ostream& os,
    const InputSignature& eval_input_sig);
 
private:
  std::optional<unsigned int> data_type_size_;
  std::optional<unsigned int> eval_set_num_;
  std::optional<bool> use_templated_loop_iters_;
};
 
//overloaded << operator to write InputSignature object to stream
inline std::ostream& operator<<(
  std::ostream& os,
  const InputSignature& eval_input_sig)
{
  os << eval_input_sig.DataTypeStr() << " "  << eval_input_sig.EvalSetNumStr()
     << " " << eval_input_sig.UseTemplatedLoopItersStr();
  return os;
}
 
#endif //INPUT_SIGNATURE_H_