[Core][Documentation] Even more documentation for pointer_vector_set.h

[loumalouomega]

📝 Description

This PR focuses on making enhancements to the PointerVectorSet documentation.-Added detailed documentation comments for various functions and methods throughout the PointerVectorSet class, including begin(), cbegin(), cend(), rbegin(), rend(), ptr_end(), ptr_rbegin(), back(), max_size(), IsSorted(), and several others. The comments provide descriptions and usage information for each function.

BTW: It would be interesting to define the iterators with adapators classes as it is done in the Parameters class to extend the capabilities of the adaptors, I have tried with:

    // Iterator adapter classes
    class iterator_adaptor 
        : public boost::indirect_iterator<typename TContainerType::iterator>
    {
    public:
        using BaseIterator = typename TContainerType::iterator;
        using BaseType = boost::indirect_iterator<BaseIterator>;

        iterator_adaptor(BaseIterator base)
            : BaseType(base) {}
        // You can add more methods or override existing methods if needed
    };

    class const_iterator_adaptor 
        : public boost::indirect_iterator<typename TContainerType::const_iterator>
    {
    public:
        using BaseIterator = typename TContainerType::const_iterator;
        using BaseType = boost::indirect_iterator<BaseIterator>;

        const_iterator_adaptor(BaseIterator base)
            : BaseType(base) {}
        // You can add more methods or override existing methods if needed
    };

    class reverse_iterator_adaptor 
        : public boost::indirect_iterator<typename TContainerType::reverse_iterator>
    {
    public:
        using BaseIterator = typename TContainerType::reverse_iterator;
        using BaseType = boost::indirect_iterator<BaseIterator>;

        reverse_iterator_adaptor(BaseIterator base)
            : BaseType(base) {}
        // You can add more methods or override existing methods if needed
    };

    class const_reverse_iterator_adaptor 
        : public boost::indirect_iterator<typename TContainerType::const_reverse_iterator>
    {
    public:
        using BaseIterator = typename TContainerType::const_reverse_iterator;
        using BaseType = boost::indirect_iterator<BaseIterator>;

        const_reverse_iterator_adaptor(BaseIterator base)
            : BaseType(base) {}
        // You can add more methods or override existing methods if needed
    };

    /// Define the iterators
    using iterator = iterator_adaptor;
    using const_iterator = const_iterator_adaptor;
    using reverse_iterator = reverse_iterator_adaptor;
    using const_reverse_iterator = const_reverse_iterator_adaptor;

But it fails compilation, probably because some missing definitions.

🆕 Changelog

• Even more documentation for pointer_vector_set.h