types.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 <torch/types.h>
 
namespace neml2
{
using Real = double;
using Integer = int;
using Size = int64_t;
using TensorShape = torch::SmallVector<Size>;
using TensorShapeRef = torch::IntArrayRef;
 
// Bring in torch::indexing
namespace indexing
{
using namespace torch::indexing;
using TensorIndices = torch::SmallVector<TensorIndex>;
using TensorIndicesRef = torch::ArrayRef<TensorIndex>;
}
 
struct TraceableSize : public std::variant<Size, torch::Tensor>
{
  using std::variant<Size, torch::Tensor>::variant;
 
  const torch::Tensor * traceable() const noexcept;
 
  Size concrete() const;
 
  torch::Tensor as_tensor() const;
};
 
bool operator==(const TraceableSize & lhs, const TraceableSize & rhs);
bool operator!=(const TraceableSize & lhs, const TraceableSize & rhs);
 
std::ostream & operator<<(std::ostream & os, const TraceableSize & s);
 
struct TraceableTensorShape : public torch::SmallVector<TraceableSize>
{
  using torch::SmallVector<TraceableSize>::SmallVector;
  using Size = int64_t;
 
  TraceableTensorShape(const TensorShape & shape);
  TraceableTensorShape(TensorShapeRef shape);
  TraceableTensorShape(Size shape);
  TraceableTensorShape(const torch::Tensor & shape);
 
  TraceableTensorShape slice(Size start, Size end) const;
 
  TraceableTensorShape slice(Size N) const;
 
  TensorShape concrete() const;
 
  torch::Tensor as_tensor() const;
};
 
bool operator==(const TraceableTensorShape & lhs, const TraceableTensorShape & rhs);
bool operator!=(const TraceableTensorShape & lhs, const TraceableTensorShape & rhs);
 
enum class FType : int8_t
{
  NONE = 0,
  INPUT = 1 << 0,
  OUTPUT = 1 << 1,
  PARAMETER = 1 << 2,
  BUFFER = 1 << 3
};
 
torch::TensorOptions & default_tensor_options();
torch::TensorOptions & default_integer_tensor_options();
torch::Dtype & default_dtype();
torch::Dtype & default_integer_dtype();
torch::Device & default_device();
 
Real & machine_precision();
Real & tolerance();
Real & tighter_tolerance();
 
std::string & buffer_name_separator();
std::string & parameter_name_separator();
 
bool & currently_solving_nonlinear_system();
 
} // namespace neml2