DataIO.hpp

Go to the documentation of this file.

#pragma once
 
#include "MayaFlux/Kakshya/Utils/DataUtils.hpp"
#include "StructureIntrospection.hpp"
 
namespace MayaFlux::Yantra {
 
/**
 * @struct IO
 * @brief Input/Output container for computation pipeline data flow with structure preservation.
 * @tparam T Data type that satisfies ComputeData concept
 *
 * Encapsulates data with associated structure information and metadata for pipeline operations.
 * The structure (dimensions and modality) is automatically inferred at construction time,
 * ensuring that all data flowing through operations carries its dimensional context.
 *
 * Key Features:
 * - Automatic structure inference from data type and content
 * - Dimension and modality preservation through pipeline operations
 * - Flexible metadata storage for operation-specific information
 * - Move semantics for efficiency with large data
 */
template <ComputeData T = std::vector<Kakshya::DataVariant>>
struct MAYAFLUX_API IO {
    T data; ///< The actual computation data
    std::vector<Kakshya::DataDimension> dimensions; ///< Data dimensional structure
    Kakshya::DataModality modality {}; ///< Data modality (audio, image, spectral, etc.)
    std::unordered_map<std::string, std::any> metadata; ///< Associated metadata
    bool b_container_processing {};
 
    std::optional<std::shared_ptr<Kakshya::SignalSourceContainer>> container; ///< Optional reference to container, required for regions
 
    IO() = default; ///< Default constructor
 
    /**
     * @brief Construct from data by copy with automatic structure inference
     * @param d Data to copy into the container
     *
     * Automatically infers dimensions and modality from the data type and content.
     * For containers, uses their existing dimensional information.
     * For other types, creates appropriate dimensional structures.
     */
    IO(const T& d)
        : data(d)
    {
        auto [dims, mod] = infer_structure(d);
        dimensions = std::move(dims);
        modality = mod;
    }
 
    /**
     * @brief Construct from data by copy with container reference and automatic structure inference
     * @param d Data to copy into the container
     * @param cont Shared pointer to the associated RegionLike Data
     *
     * This constructor is useful when the data is part of a larger container
     * and we want to maintain a reference to that container for context.
     */
    IO(const T& d, const std::shared_ptr<Kakshya::SignalSourceContainer>& cont)
        : data(d)
        , container(cont)
    {
        auto [dims, mod] = infer_structure(d);
        dimensions = std::move(dims);
        modality = mod;
    }
 
    /**
     * @brief Construct from data by move with automatic structure inference
     * @param d Data to move into the container
     *
     * Automatically infers dimensions and modality before moving the data.
     * More efficient for large data structures.
     */
    IO(T&& d)
        : data(std::move(d))
    {
        // Note: We infer from data after it's moved, which should be fine
        // since inference typically only needs type info and basic properties
        auto [dims, mod] = infer_structure(data);
        dimensions = std::move(dims);
        modality = mod;
    }
 
    /**
     * @brief Construct from data by move with automatic structure inference
     * @param d Data to move into the container
     * @param cont Shared pointer to the associated RegionLike Data
     *
     * Automatically infers dimensions and modality before moving the data.
     * More efficient for large data structures.
     */
    IO(T&& d, const std::shared_ptr<Kakshya::SignalSourceContainer>& cont)
        : data(std::move(d))
        , container(cont)
    {
        auto [dims, mod] = infer_structure(data);
        dimensions = std::move(dims);
        modality = mod;
    }
 
    /**
     * @brief Construct with move and explicit structure information
     * @param d Data to move
     * @param dims Explicit dimensional structure
     * @param mod Explicit data modality
     */
    IO(T&& d, std::vector<Kakshya::DataDimension> dims, Kakshya::DataModality mod)
        : data(std::move(d))
        , dimensions(std::move(dims))
        , modality(mod)
    {
    }
 
    /**
     * @brief Construct with move and explicit structure information
     * @param d Data to move
     * @param container Shared pointer to the associated RegionLike Data
     * @param dims Explicit dimensional structure
     * @param mod Explicit data modality
     */
    IO(T&& d, const std::shared_ptr<Kakshya::SignalSourceContainer> container, std::vector<Kakshya::DataDimension> dims, Kakshya::DataModality mod)
        : data(std::move(d))
        , container(container)
        , dimensions(std::move(dims))
        , modality(mod)
    {
    }
 
    /**
     * @brief Access underlying data (const)
     * @return Const reference to the data
     */
    const T& operator*() const { return data; }
 
    /**
     * @brief Access underlying data (mutable)
     * @return Mutable reference to the data
     */
    T& operator*() { return data; }
 
    /**
     * @brief Set or update the associated container reference
     * @param cont Shared pointer to the new container
     */
    void set_container(const std::shared_ptr<Kakshya::SignalSourceContainer>& cont)
    {
        container = cont;
    }
 
    /**
     * @brief Check if a container reference is associated
     * @return True if a container is set
     */
    [[nodiscard]] bool has_container() const
    {
        return container.has_value();
    }
 
    /**
     * @brief Check if processing is needed (for container types)
     * @return True if processing is required before data extraction
     */
    [[nodiscard]] bool needs_processig() const
    {
        if constexpr (std::is_same_v<T, std::shared_ptr<Kakshya::SignalSourceContainer>>) {
            return b_container_processing;
        }
        return false;
    }
 
    /**
     * @brief Set whether processing is needed (for container types)
     * @param val True if processing should be done before data extraction
     */
    void set_container_processing(bool val)
    {
        if constexpr (std::is_same_v<T, std::shared_ptr<Kakshya::SignalSourceContainer>>) {
            b_container_processing = val;
        } else {
            b_container_processing = false;
        }
    }
 
    /**
     * @brief Check if data has specific modality
     * @param target_modality Modality to check for
     * @return True if data matches the target modality
     */
    [[nodiscard]] bool has_modality(Kakshya::DataModality target_modality) const
    {
        return modality == target_modality;
    }
 
    /**
     * @brief Get total number of elements across all dimensions
     * @return Product of all dimension sizes
     */
    [[nodiscard]] uint64_t get_total_elements() const
    {
        uint64_t total = 1;
        for (const auto& dim : dimensions) {
            total *= dim.size;
        }
        return total;
    }
 
    /**
     * @brief Find dimension by semantic role
     * @param role Dimension role to search for
     * @return Index of dimension with that role, or -1 if not found
     */
    [[nodiscard]] int find_dimension_by_role(Kakshya::DataDimension::Role role) const
    {
        return Kakshya::find_dimension_by_role(dimensions, role);
    }
 
    /**
     * @brief Check if data is suitable for a specific type of processing
     * @param required_modality Required data modality
     * @param min_dimensions Minimum number of dimensions required
     * @return True if data meets the requirements
     */
    [[nodiscard]] bool is_suitable_for_processing(Kakshya::DataModality required_modality,
        size_t min_dimensions = 1) const
    {
        if constexpr (RequiresContainer<T>) {
            if (!container.has_value()) {
                return false;
            }
        }
        return (modality == required_modality || required_modality == Kakshya::DataModality::UNKNOWN) && dimensions.size() >= min_dimensions;
    }
 
    /**
     * @brief Update structure information (use carefully!)
     * @param new_dims New dimensional structure
     * @param new_modality New data modality
     *
     * This allows operations to update structure info when they transform
     * the data in ways that change its dimensional characteristics.
     */
    void update_structure(std::vector<Kakshya::DataDimension> new_dims,
        Kakshya::DataModality new_modality)
    {
        dimensions = std::move(new_dims);
        modality = new_modality;
    }
 
    /**
     * @brief Add or update metadata entry
     * @param key Metadata key
     * @param value Metadata value
     */
    template <typename ValueType>
    void set_metadata(const std::string& key, ValueType&& value)
    {
        metadata[key] = std::forward<ValueType>(value);
    }
 
    /**
     * @brief Get metadata entry with type safety
     * @tparam ValueType Expected value type
     * @param key Metadata key
     * @return Optional value if found and correct type
     */
    template <typename ValueType>
    std::optional<ValueType> get_metadata(const std::string& key) const
    {
        auto it = metadata.find(key);
        if (it != metadata.end()) {
            try {
                return std::any_cast<ValueType>(it->second);
            } catch (const std::bad_any_cast&) {
                return std::nullopt;
            }
        }
        return std::nullopt;
    }
};
 
/**
 * @class OpUnit
 * @brief Abstract base class for operation units in recursive processing graphs.
 * @tparam T Data type that satisfies ComputeData concept
 *
 * Represents a single computational node that can process data and maintain
 * dependencies on other operation units. Forms the building blocks of
 * computation pipelines with automatic dependency resolution.
 */
template <ComputeData T = std::vector<Kakshya::DataVariant>>
class OpUnit {
public:
    virtual ~OpUnit() = default;
 
    /**
     * @brief Execute the operation on input data
     * @param input Input data container with metadata
     * @return Processed output data container
     */
    virtual IO<T> execute(const IO<T>& input) = 0;
 
    /**
     * @brief Get the name/identifier of this operation
     * @return String name of the operation
     */
    [[nodiscard]] virtual std::string get_name() const = 0;
 
    /**
     * @brief Add a dependency operation unit
     * @param dep Shared pointer to the dependency operation
     *
     * Dependencies are executed before this operation in the pipeline.
     */
    void add_dependency(std::shared_ptr<OpUnit<T>> dep)
    {
        dependencies.push_back(std::move(dep));
    }
 
    /**
     * @brief Get all dependency operations
     * @return Const reference to the dependencies vector
     */
    const auto& get_dependencies() const { return dependencies; }
 
protected:
    std::vector<std::shared_ptr<OpUnit<T>>> dependencies; ///< Operation dependencies
};
 
/// Helper to detect if a type is an IO
template <typename>
struct is_IO : std::false_type { };
/// Specialization for IO types
template <typename T>
struct is_IO<IO<T>> : std::true_type { };
 
/**
 * @concept OperationReadyData
 * @brief Concept to constrain types suitable for operation units
 *
 * Ensures that types used in operation units are either:
 * - MultiVariant (universal data variant)
 * - RegionLike (regions or region groups)
 * - EigenMatrixLike (Eigen matrices/vectors)
 * - IO (input/output containers with structure)
 */
template <typename T>
concept OperationReadyData = MultiVariant<T> || RegionLike<T> || EigenMatrixLike<T> || is_IO<T>::value;
 
using DataIO = IO<std::vector<Kakshya::DataVariant>>; ///< IO for universal data variant
using ContainerIO = IO<std::shared_ptr<Kakshya::SignalSourceContainer>>; ///< IO for signal containers
using RegionIO = IO<Kakshya::Region>; ///< IO for single regions
using RegionGroupIO = IO<Kakshya::RegionGroup>; ///< IO for region groups
using SegmentIO = IO<std::vector<Kakshya::RegionSegment>>; ///< IO for region segments
 
}