AxisLayout.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 <vector>
 
#include "neml2/misc/types.h"
 
namespace neml2
{
struct AxisLayout
{
  AxisLayout() = default;

  enum class IStructure : uint8_t
  {
    DENSE, 
    BLOCK, 
  };

  AxisLayout(const std::vector<std::vector<VariableName>> & vars,
             std::vector<TensorShape> intmd_shapes,
             std::vector<TensorShape> base_shapes,
             std::vector<IStructure> istrs);

  AxisLayout(const AxisLayout * parent,
             std::size_t group_idx,
             std::size_t start,
             std::size_t end,
             std::vector<std::size_t> offsets = {});

  std::size_t ngroup() const;
  std::pair<std::size_t, std::size_t> group_offsets(std::size_t) const;
  AxisLayout group(std::size_t) const;
  IStructure istr(std::size_t = 0) const;
  AxisLayout view() const;
  bool is_view() const { return _parent != nullptr; }

  std::size_t nvar() const;
  std::vector<Size> storage_sizes(bool include_intmd) const;

  std::vector<VariableName> vars() const;
  const VariableName & var(std::size_t) const;
  const TensorShape & intmd_sizes(std::size_t) const;
  const TensorShape & base_sizes(std::size_t) const;

  void update_intmd_shapes(const std::vector<TensorShape> &);
 
private:
  std::vector<VariableName> _vars;
  std::vector<TensorShape> _intmd_shapes;
  std::vector<TensorShape> _base_shapes;
  std::vector<std::size_t> _offsets;
  std::vector<IStructure> _istrs;

  const AxisLayout * _parent = nullptr;
  std::size_t _group_idx = 0;
  std::size_t _start = 0;
  std::size_t _end = 0;
};

bool operator==(const AxisLayout &, const AxisLayout &);
} // namespace neml2