TensorBase.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 <ATen/core/Tensor.h>
 
#include "neml2/tensors/TraceableSize.h"
#include "neml2/tensors/TraceableTensorShape.h"
#include "neml2/tensors/functions/operators.h"
#include "neml2/tensors/functions/logical.h"
#include "neml2/tensors/indexing.h"
#include "neml2/tensors/macros.h"
 
namespace neml2
{
// Forward declarations
template <class Derived>
class TensorBase;
 
class Tensor;
 
template <class Derived>
class TensorBase : public ATensor
{
public:
  TensorBase() = default;
 
  TensorBase(const ATensor & tensor, Size dynamic_dim, Size intmd_dim);
 
  TensorBase(const ATensor & tensor, TraceableTensorShape dynamic_shape, Size intmd_dim);
 
  template <class Derived2>
  TensorBase(const TensorBase<Derived2> & tensor)
    : TensorBase(tensor, tensor.dynamic_sizes(), tensor.intmd_dim())
  {
  }
 
  TensorBase(double) = delete;
  TensorBase(float) = delete;
  TensorBase(int) = delete;
 
  [[nodiscard]] static Derived empty_like(const Derived & other);
  [[nodiscard]] static Derived zeros_like(const Derived & other);
  [[nodiscard]] static Derived ones_like(const Derived & other);
  [[nodiscard]] static Derived full_like(const Derived & other, const CScalar & init);
  [[nodiscard]] static Derived rand_like(const Derived & other);
 
  Derived contiguous() const;
  Derived clone() const;
  Derived detach() const;
  using ATensor::detach_;
  Derived to(const TensorOptions & options) const;
  using ATensor::copy_;
  using ATensor::zero_;
  using ATensor::requires_grad;
  using ATensor::requires_grad_;
  Derived operator-() const;
 
  using ATensor::defined;
  using ATensor::options;
  using ATensor::scalar_type;
  using ATensor::device;
 
  using ATensor::dim;
  Size batch_dim() const;
  Size base_dim() const;
  Size dynamic_dim() const;
  Size static_dim() const;
  Size intmd_dim() const;
 
  using ATensor::sizes;
  TraceableTensorShape batch_sizes() const;
  TensorShapeRef base_sizes() const;
  const TraceableTensorShape & dynamic_sizes() const;
  TensorShapeRef static_sizes() const;
  TensorShapeRef intmd_sizes() const;
 
  using ATensor::size;
  TraceableSize batch_size(Size i) const;
  Size base_size(Size i) const;
  const TraceableSize & dynamic_size(Size i) const;
  Size static_size(Size i) const;
  Size intmd_size(Size i) const;
 
  using ATensor::index;
  using ATensor::index_put_;
 
  Derived dynamic_index(indexing::TensorIndicesRef indices) const;
  Derived intmd_index(indexing::TensorIndicesRef indices) const;
  neml2::Tensor base_index(indexing::TensorIndicesRef indices) const;
  Derived batch_index(indexing::TensorIndicesRef indices) const;
 
  Derived dynamic_slice(Size d, const indexing::Slice & index) const;
  Derived intmd_slice(Size d, const indexing::Slice & index) const;
  neml2::Tensor base_slice(Size d, const indexing::Slice & index) const;
  Derived batch_slice(Size d, const indexing::Slice & index) const;
 
  void dynamic_index_put_(indexing::TensorIndicesRef indices, const ATensor & other);
  void dynamic_index_put_(indexing::TensorIndicesRef indices, const CScalar & v);
  void intmd_index_put_(indexing::TensorIndicesRef indices, const ATensor & other);
  void intmd_index_put_(indexing::TensorIndicesRef indices, const CScalar & v);
  void base_index_put_(indexing::TensorIndicesRef indices, const ATensor & other);
  void base_index_put_(indexing::TensorIndicesRef indices, const CScalar & v);
  void batch_index_put_(indexing::TensorIndicesRef indices, const ATensor & other);
  void batch_index_put_(indexing::TensorIndicesRef indices, const CScalar & v);
 
  Derived variable_data() const;
 
  Derived dynamic_expand(const TraceableTensorShape & shape) const;
  Derived intmd_expand(TensorShapeRef shape) const;
  neml2::Tensor base_expand(TensorShapeRef shape) const;
  Derived batch_expand(const TraceableTensorShape & dynamic_shape,
                       TensorShapeRef intmd_shape = {}) const;
  neml2::Tensor static_expand(TensorShapeRef intmd_shape, TensorShapeRef base_shape) const;
 
  Derived dynamic_expand(const TraceableSize & size, Size d) const;
  Derived intmd_expand(Size size, Size d) const;
  neml2::Tensor base_expand(Size size, Size d) const;
 
  Derived dynamic_expand_as(const neml2::Tensor & other) const;
  Derived intmd_expand_as(const neml2::Tensor & other) const;
  neml2::Tensor base_expand_as(const neml2::Tensor & other) const;
  Derived batch_expand_as(const neml2::Tensor & other) const;
  neml2::Tensor static_expand_as(const neml2::Tensor & other) const;
 
  Derived dynamic_reshape(const TraceableTensorShape & shape) const;
  Derived intmd_reshape(TensorShapeRef shape) const;
  neml2::Tensor base_reshape(TensorShapeRef shape) const;
  Derived batch_reshape(const TraceableTensorShape & dynamic_shape,
                        TensorShapeRef intmd_shape = {}) const;
  neml2::Tensor static_reshape(TensorShapeRef intmd_shape, TensorShapeRef base_shape) const;
 
  Derived dynamic_squeeze(Size d) const;
  Derived intmd_squeeze(Size d) const;
  neml2::Tensor base_squeeze(Size d) const;
  Derived batch_squeeze(Size d) const;
 
  Derived dynamic_unsqueeze(Size d, Size n = 1) const;
  Derived intmd_unsqueeze(Size d, Size n = 1) const;
  neml2::Tensor base_unsqueeze(Size d, Size n = 1) const;
  Derived batch_unsqueeze(Size d, Size n = 1) const;
 
  Derived dynamic_transpose(Size d1, Size d2) const;
  Derived intmd_transpose(Size d1, Size d2) const;
  neml2::Tensor base_transpose(Size d1, Size d2) const;
  Derived batch_transpose(Size d1, Size d2) const;
 
  Derived dynamic_movedim(Size old_dim, Size new_dim) const;
  Derived intmd_movedim(Size old_dim, Size new_dim) const;
  neml2::Tensor base_movedim(Size old_dim, Size new_dim) const;
  Derived batch_movedim(Size old_dim, Size new_dim) const;
 
  Derived dynamic_flatten() const;
  Derived intmd_flatten() const;
  neml2::Tensor base_flatten() const;
  Derived batch_flatten() const;
  neml2::Tensor static_flatten() const;
 
protected:
  void validate_shapes_and_dims() const;
 
private:
  TraceableTensorShape _dynamic_sizes;
 
  // BTW, "intmd" is an abbreviation for "intermediate" found in the Merriam-Webster dictionary :)
  Size _intmd_dim = 0;
};
 
// Export TensorBase so other TU don't repeat the instantiation
#define EXPORT_TENSORBASE(T) extern template class TensorBase<T>
FOR_ALL_TENSORBASE(EXPORT_TENSORBASE);
#undef EXPORT_TENSORBASE
} // namespace neml2