RuntimeOptions.hpp

// Copyright (c) 2021 Graphcore Ltd. All rights reserved.
 
#ifndef poplar_RuntimeOptions_hpp
#define poplar_RuntimeOptions_hpp
 
#include <poplar/OptionFlags.hpp>
 
namespace poplar {
 
namespace core {
struct RuntimeOptions;
}
 
class RuntimeOptions {
public:
  // Name of an environment variable reserved to parse runtime options
  static const char *EnvVarName;
 
  // Construct a RuntimeOptions object from a flags object.
  // Flags from the environment variable are parsed and take precedence.
  explicit RuntimeOptions(const OptionFlags &options);
 
  // Copy constructor. Does not parse environment variable.
  RuntimeOptions(const RuntimeOptions &options);
 
  // Move constructor. Does not parse environment variable.
  RuntimeOptions(RuntimeOptions &&);
 
  // Copy-assignment operator. Does not parse environment variable.
  RuntimeOptions &operator=(const RuntimeOptions &);
 
  // Move-assignment operator. Does not parse environment variable.
  RuntimeOptions &operator=(RuntimeOptions &&);
 
  ~RuntimeOptions();
 
  bool operator==(const RuntimeOptions &);
 
  const core::RuntimeOptions *getImpl() const { return impl.get(); }
 
private:
  std::unique_ptr<core::RuntimeOptions> impl;
};
 
} // namespace poplar
 
// Hashing support for RuntimeOptions
namespace std {
template <> struct hash<poplar::RuntimeOptions> {
  size_t operator()(const poplar::RuntimeOptions &) const;
};
} // namespace std
 
#endif // poplar_RuntimeOptions_hpp