FixedDimTensor.h

// Copyright 2023, 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/BatchTensor.h"
 
namespace neml2
{
template <class Derived, TorchSize... S>
class FixedDimTensor : public BatchTensorBase<Derived>
{
public:
  static inline const TorchShape const_base_sizes = {S...};
 
  static constexpr TorchSize const_base_dim = sizeof...(S);
 
  static inline const TorchSize const_base_storage = utils::storage_size({S...});
 
  FixedDimTensor() = default;
 
  explicit FixedDimTensor(const torch::Tensor & tensor, TorchSize batch_dim);
 
  FixedDimTensor(const torch::Tensor & tensor);
 
  operator BatchTensor() const;
 
  [[nodiscard]] static Derived
  empty(const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived
  empty(TorchShapeRef batch_shape, const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived
  zeros(const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived
  zeros(TorchShapeRef batch_shape, const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived
  ones(const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived
  ones(TorchShapeRef batch_shape, const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived
  full(Real init, const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived
  full(TorchShapeRef batch_shape,
       Real init,
       const torch::TensorOptions & options = default_tensor_options());
 
  [[nodiscard]] static BatchTensor identity_map(const torch::TensorOptions &)
  {
    throw NEMLException("Not implemented");
  }
};
 
// Implementations
 
template <class Derived, TorchSize... S>
FixedDimTensor<Derived, S...>::FixedDimTensor(const torch::Tensor & tensor, TorchSize batch_dim)
  : BatchTensorBase<Derived>(tensor, batch_dim)
{
  neml_assert_dbg(this->base_sizes() == const_base_sizes,
                  "Base shape mismatch: trying to create a tensor with base shape ",
                  const_base_sizes,
                  " from a tensor with base shape ",
                  this->base_sizes());
}
 
template <class Derived, TorchSize... S>
FixedDimTensor<Derived, S...>::FixedDimTensor(const torch::Tensor & tensor)
  : BatchTensorBase<Derived>(tensor, tensor.dim() - const_base_dim)
{
  neml_assert_dbg(this->base_sizes() == const_base_sizes,
                  "Base shape mismatch: trying to create a tensor with base shape ",
                  const_base_sizes,
                  " from a tensor with shape ",
                  tensor.sizes());
}
 
template <class Derived, TorchSize... S>
FixedDimTensor<Derived, S...>::operator BatchTensor() const
{
  return BatchTensor(*this, this->batch_dim());
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::empty(const torch::TensorOptions & options)
{
  return Derived(torch::empty(const_base_sizes, options), 0);
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::empty(TorchShapeRef batch_shape,
                                     const torch::TensorOptions & options)
{
  return Derived(torch::empty(utils::add_shapes(batch_shape, const_base_sizes), options),
                 batch_shape.size());
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::zeros(const torch::TensorOptions & options)
{
  return Derived(torch::zeros(const_base_sizes, options), 0);
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::zeros(TorchShapeRef batch_shape,
                                     const torch::TensorOptions & options)
{
  return Derived(torch::zeros(utils::add_shapes(batch_shape, const_base_sizes), options),
                 batch_shape.size());
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::ones(const torch::TensorOptions & options)
{
  return Derived(torch::ones(const_base_sizes, options), 0);
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::ones(TorchShapeRef batch_shape, const torch::TensorOptions & options)
{
  return Derived(torch::ones(utils::add_shapes(batch_shape, const_base_sizes), options),
                 batch_shape.size());
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::full(Real init, const torch::TensorOptions & options)
{
  return Derived(torch::full(const_base_sizes, init, options), 0);
}
 
template <class Derived, TorchSize... S>
Derived
FixedDimTensor<Derived, S...>::full(TorchShapeRef batch_shape,
                                    Real init,
                                    const torch::TensorOptions & options)
{
  return Derived(torch::full(utils::add_shapes(batch_shape, const_base_sizes), init, options),
                 batch_shape.size());
}
} // namespace neml2