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/jit/TraceableTensorShape.h"
#include "neml2/tensors/functions/operators.h"
#include "neml2/tensors/indexing.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 batch_dim);
 
  TensorBase(const ATensor & tensor, const TraceableTensorShape & batch_shape);
 
  TensorBase(const neml2::Tensor & tensor);
 
  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
  linspace(const Derived & start, const Derived & end, Size nstep, Size dim = 0);
  [[nodiscard]] static Derived logspace(const Derived & start,
                                        const Derived & end,
                                        Size nstep,
                                        Size dim = 0,
                                        const CScalar & base = 10);
 
  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::options;
  using ATensor::scalar_type;
  using ATensor::device;
  using ATensor::dim;
  using ATensor::sizes;
  using ATensor::size;
  bool batched() const;
  Size batch_dim() const;
  Size base_dim() const;
  const TraceableTensorShape & batch_sizes() const;
  TraceableSize batch_size(Size index) const;
  TensorShapeRef base_sizes() const;
  Size base_size(Size index) const;
  Size base_storage() const;
 
  using ATensor::index;
  using ATensor::index_put_;
  Derived batch_index(indexing::TensorIndicesRef indices) const;
  neml2::Tensor base_index(indexing::TensorIndicesRef indices) const;
  Derived batch_slice(Size dim, const indexing::Slice & index) const;
  neml2::Tensor base_slice(Size dim, const indexing::Slice & index) const;
  void batch_index_put_(indexing::TensorIndicesRef indices, const ATensor & other);
  void batch_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);
  Derived variable_data() const;
 
  Derived batch_expand(const TraceableTensorShape & batch_shape) const;
  Derived batch_expand(const TraceableSize & batch_size, Size dim) const;
  neml2::Tensor base_expand(TensorShapeRef base_shape) const;
  neml2::Tensor base_expand(Size base_size, Size dim) const;
  Derived batch_expand_as(const neml2::Tensor & other) const;
  neml2::Tensor base_expand_as(const neml2::Tensor & other) const;
  Derived batch_expand_copy(const TraceableTensorShape & batch_shape) const;
  neml2::Tensor base_expand_copy(TensorShapeRef base_shape) const;
  Derived batch_reshape(const TraceableTensorShape & batch_shape) const;
  neml2::Tensor base_reshape(TensorShapeRef base_shape) const;
  Derived batch_unsqueeze(Size d) const;
  neml2::Tensor base_unsqueeze(Size d) const;
  Derived batch_transpose(Size d1, Size d2) const;
  neml2::Tensor base_transpose(Size d1, Size d2) const;
  neml2::Tensor base_flatten() const;
 
protected:
  TraceableTensorShape _batch_sizes;
};
} // namespace neml2