concepts.hpp

Go to the documentation of this file.

// Copyright 2025 Eric Hermosis
//
// This file is part of the Tannic Tensor Library.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// 
 
#ifndef CONCEPTS_HPP
#define CONCEPTS_HPP 
 
#include <concepts>
#include <iterator>   
#include "types.hpp"
 
namespace tannic {
 
class Shape;
class Strides;
class Tensor; 
 
template<typename T>
concept Expression = requires(const T expression) {
    { expression.dtype()   } -> std::same_as<type>;
    { expression.shape()   } -> std::same_as<Shape const&>;
    { expression.strides() } -> std::same_as<Strides const&>;
      expression.offset();
      expression.forward();
}; 
 
template<typename T>
concept Operator = requires(T operation, const Shape& first, const Shape& second) {
    { T::promote(type{}, type{}) } -> std::same_as<type>;
    { T::broadcast(first, second) } -> std::same_as<Shape>; 
};
 
template<typename Function>
concept Functional = requires(Function function, const Tensor& input, Tensor& output) {
    { function(input, output) } -> std::same_as<void>;
};
 
template<typename T>
concept Iterable = requires(T type) { std::begin(type); std::end(type); };   
 
template <typename T>
concept Iterator = std::input_iterator<T>;  
 
template<typename T>
concept Integral = std::is_integral_v<T>; 
 
 
template<typename T>
concept Assignable = requires(T t, const std::byte* ptr, std::ptrdiff_t offset) {
    { t.assign(ptr, offset) } -> std::same_as<void>;
};
 
template<typename T>
concept Comparable = requires(const T t, const std::byte* ptr, std::ptrdiff_t offset) {
    { t.compare(ptr, offset) } -> std::same_as<bool>;
}; 
 
} // namespace tannic
 
#endif // CONCEPTS_HPP