CrossRef.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/tensors/tensors.h"
 
#include <sstream>
 
namespace neml2
{
// Forward decl
template <typename T>
class CrossRef;
 
template <typename T>
std::stringstream & operator>>(std::stringstream &, CrossRef<T> &);
 
template <typename T>
class CrossRef
{
public:
  CrossRef() = default;
 
  CrossRef(const std::string & raw)
    : _raw_str(raw)
  {
  }
 
  CrossRef<T> & operator=(const std::string & other);
 
  operator T() const;
 
  bool operator==(const CrossRef<T> & other) const { return _raw_str == other.raw(); }
 
  const std::string & raw() const { return _raw_str; }
 
  friend std::stringstream & operator>> <>(std::stringstream & in, CrossRef<T> &);
 
private:
  std::string _raw_str;
};
 
// Specializations
template <>
CrossRef<torch::Tensor>::operator torch::Tensor() const;
template <>
CrossRef<Tensor>::operator Tensor() const;
#define CROSSREF_SPECIALIZE_PRIMITIVETENSOR(T)                                                     \
  template <>                                                                                      \
  CrossRef<T>::operator T() const
FOR_ALL_PRIMITIVETENSOR(CROSSREF_SPECIALIZE_PRIMITIVETENSOR);
} // namespace neml2
 
// Implementations
 
namespace neml2
{
template <typename T>
CrossRef<T> &
CrossRef<T>::operator=(const std::string & other)
{
  _raw_str = other;
  return *this;
}
 
template <typename T>
std::ostream &
operator<<(std::ostream & os, const CrossRef<T> & cr)
{
  os << cr.raw();
  return os;
}
 
template <typename T>
std::stringstream &
operator>>(std::stringstream & ss, CrossRef<T> & cr)
{
  ss >> cr._raw_str;
  return ss;
}
} // namespace neml2