Indexing.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstddef>
 
#include <stratax/core/Exceptions.hpp>
#include <stratax/core/Strides.hpp>
#include <stratax/core/Shape.hpp>
#include <stratax/core/Validation.hpp>

template<typename IndexContainer>
std::size_t offset(
    const stratax::core::Shape& shape,
    const stratax::core::Strides& strides,
    const IndexContainer& index)
{
    stratax::core::validation::require_rank(
        strides.rank(),
        shape.rank(),
        "Shape, strides, and index must have the same rank.");
    stratax::core::validation::require_rank(
        index.size(),
        shape.rank(),
        "Shape, strides, and index must have the same rank.");
 
    std::size_t result = 0;
 
    auto shape_it = shape.begin();
    auto stride_it = strides.begin();
    auto index_it = index.begin();
 
    for (; index_it != index.end(); ++shape_it, ++stride_it, ++index_it)
    {
        if (*index_it >= *shape_it)
        {
            throw Exceptions::IndexError("Index out of bounds.");
        }
 
        std::size_t term = 0;
 
        try
        {
            term = stratax::core::validation::checked_multiply(
                *index_it,
                *stride_it,
                "Index offset overflow.");
        }
        catch (const Exceptions::DimensionError&)
        {
            throw Exceptions::IndexError("Index offset overflow.");
        }
 
        try
        {
            result = stratax::core::validation::checked_add(
                result,
                term,
                "Index offset overflow.");
        }
        catch (const Exceptions::DimensionError&)
        {
            throw Exceptions::IndexError("Index offset overflow.");
        }
    }
 
    return result;
}