View concepts (details)
=======================

.. contents:: Table of Contents
    :local:


.. _concept-details-View:

View
----

.. cpp:concept:: template <typename Vw> View

    #. Refines the :cpp:concept:`template <typename Ima> Image` concept.
    #. Is basicaly an alias.

    **Possible implementation**

    .. code:: cpp

        template <typename V, Vw = remove_cvref<V>>
        concept View =  Image<Vw>;


.. _concept-details-WritableView:

WritableView
------------

.. cpp:concept:: template <typename WView> WritableView

    #. Refines the :cpp:concept:`template <typename V> View` concept.
    #. Refines the :cpp:concept:`template <typename Ima> WritableImage` concept.

    **Possible implementation**

    .. code:: cpp

        template <typename WV, WView = remove_cvref<WV>>
        concept WritableView =  View<WView> &&
                                WritableImage<WView>;


.. _concept-details-FilterView:

FilterView
----------

.. cpp:concept:: template <typename FView, typename Pred> FilterView

    #. Refines the :cpp:concept:`template <typename V> View` concept.
    #. ``Pred`` models the :cpp:concept:`template <typename F, typename... Args> Predicate` concept.

    **Notation**

    .. cpp:type::   const_pixel_type = FView::const_pixel_type
    .. cpp:var::    Pred pred
    .. cpp:var::    const_pixel_type cpix

    **Valid Expressions**

    - :cpp:expr:`pred(cpix)` return-type models :cpp:concept:`template <typename B> Boolean`.

    **Possible implementation**

    .. code:: cpp

        template <typename FV, typename Pred, FView = remove_cvref<FV>>
        concept FilterView =    View<FView> &&
                                Predicate<Pred, FView::const_pixel_type>;


.. _concept-details-WritableFilterView:

WritableFilterView
------------------

.. cpp:concept:: template <typename WFView, typename Pred> WritableFilterView

    #. Refines the :cpp:concept:`template <typename WV> WritableView` concept.
    #. Refines the :cpp:concept:`template <typename FView, typename Pred> FilterView` concept.
    #. ``Pred`` models the :cpp:concept:`template <typename F, typename... Args> Predicate` concept.

    **Notation**

    .. cpp:type::   pixel_type = WFView::pixel_type
    .. cpp:var::    Pred pred
    .. cpp:var::    pixel_type pix

    **Valid Expressions**

    - :cpp:expr:`pred(pix)` return-type models :cpp:concept:`template <typename B> Boolean`.

    **Possible implementation**

    .. code:: cpp

        template <typename WFV, typename Pred, WFView = remove_cvref<WFV>>
        concept WritableFilterView =    WritableView<WFView> &&
                                        FilterView<WFView, Pred> &&
                                        Predicate<Pred, WFView::pixel_type>;

.. _concept-details-TransformView:

TransformView
-------------

.. cpp:concept:: template <typename TView, typename Func> TransformView

    #. Refines the :cpp:concept:`template <typename V> View` concept.
    #. ``Func`` models the :cpp:concept:`template <typename R, typename F, typename... Args> InvocableR` concept.

    **Notation**

    .. cpp:type::   const_pixel_type = PView::const_pixel_type
    .. cpp:var::    Func func
    .. cpp:var::    const_pixel_type cpix

    **Valid Expressions**

    - :cpp:expr:`func(cpix)` return-type models the :cpp:concept:`template <typename ToPix, typename FromPix> TransformedPixel` concept with `ToPix = decltype(func(cpix))` and `FromPix = TView::const_pixel_type`.

    **Possible implementation**

    .. code:: cpp

        template <typename TV, typename Func, TView = remove_cvref<TV>>
        concept TransformView = View<TView> &&
                                Invocable<Func, TView::const_pixel_type> &&
                                TransformedPixel<
                                    invoke_result_t<Func, TView::const_pixel_type>,
                                    TView::const_pixel_type>;


.. _concept-details-WritableTransformView:

WritableTransformView
---------------------

.. cpp:concept:: template <typename WTView, typename Func, typename FuncInverse> WritableTransformView

    #. Refines the :cpp:concept:`template <typename TView, typename Func> TransformView` concept.
    #. ``Func`` models the :cpp:concept:`template <typename R, typename F, typename... Args> InvocableR` concept.
    #. ``FuncInverse`` models the :cpp:concept:`template <typename R, typename F, typename... Args> InvocableR` concept where ``R`` models the :cpp:concept:`template <typename Pix> Pixel` concept.

    **Notation**

    .. cpp:type::   pixel_type = WTView::pixel_type
    .. cpp:var::    Func func
    .. cpp:var::    FuncInverse func_inverse
    .. cpp:var::    pixel_type pix

    **Valid Expressions**

    - :cpp:expr:`func(pix)` return-type models the :cpp:concept:`template <typename ToPix, typename FromPix> TransformedPixel` concept with `ToPix = decltype(func(pix))` and `FromPix = WTView::pixel_type`.
    - :cpp:expr:`func_inverse(func(pix))` return-type models :cpp:concept:`template <typename Pix> Pixel` and is the same as :cpp:expr:`pixel_type`.

    **Possible implementation**

    .. code:: cpp

        template <typename WTV, typename Func, typename FuncInverse, WTView = remove_cvref<WTV>>
        concept WritableTransformView =
            View<WTView> &&
            TransformView<WTView> &&

            Invocable<Func, WTView::pixel_type> &&
            TransformedPixel<
                invoke_result_t<Func, WTView::pixel_type>,
                WTView::pixel_type> &&

            Invocable<FuncInverse, invoke_result_t<Func, WTView::pixel_type> &&
            Pixel<
                invoke_result_t<FuncInverse, invoke_result_t<Func, WTView::pixel_type>> &&
            Same<
                WTView::pixel_type
                invoke_result_t<FuncInverse, invoke_result_t<Func, WTView::pixel_type>>;


.. _concept-details-ProjectorView:

ProjectorView
-------------

.. cpp:concept:: template <typename PView, typename Proj> ProjectorView

    #. Refines the :cpp:concept:`template <typename V> View` concept.
    #. ``Proj`` models the :cpp:concept:`template <typename R, typename F, typename... Args> InvocableR` concept.

    **Notation**

    .. cpp:type::   const_pixel_type = PView::const_pixel_type
    .. cpp:var::    Proj proj
    .. cpp:var::    const_pixel_type cpix

    **Valid Expressions**

    - :cpp:expr:`proj(cpix)` return-type models the :cpp:concept:`template <typename ToPix, typename FromPix> ProjectedPixel` concept with `ToPix = decltype(proj(cpix))` and `FromPix = PView::const_pixel_type`.

    **Possible implementation**

    .. code:: cpp

        template <typename PV, typename Proj, PView = remove_cvref<PV>>
        concept ProjectorView = View<PView> &&
                                Invocable<Proj, PView::const_pixel_type> &&
                                ProjectedPixel<
                                    invoke_result_t<Proj, PView::const_pixel_type>,
                                    PView::const_pixel_type>;


.. _concept-details-WritableProjectorView:

WritableProjectorView
---------------------

.. cpp:concept:: template <typename WPView, typename Proj> WritableProjectorView

    #. Refines the :cpp:concept:`template <typename WV> WritableView` concept.
    #. Refines the :cpp:concept:`template <typename PView, typename Proj> ProjectorView` concept.
    #. ``Proj`` models the :cpp:concept:`template <typename R, typename F, typename... Args> InvocableR` concept.
   
    **Notation**

    .. cpp:type::   pixel_type = WPView::pixel_type
    .. cpp:var::    Proj proj
    .. cpp:var::    pixel_type pix

    **Valid Expressions**

    - :cpp:expr:`proj(pix)` return-type models the :cpp:concept:`template <typename ToPix, typename FromPix> ProjectedPixel` concept with `ToPix = decltype(proj(pix))` and `FromPix = WPView::pixel_type`.

    **Possible implementation**

    .. code:: cpp

        template <typename WPV, typename Proj, WPView = remove_cvref<WPV>>
        concept WritableProjectorView = WritableView<WPView> &&
                                        ProjectorView<WPView, Proj> &&
                                        Invocable<Proj, WPView::pixel_type> &&
                                        ProjectedPixel<
                                            invoke_result_t<Proj, WPView::pixel_type>,
                                            WPView::pixel_type>;


.. _concept-details-ZipView:

ZipView
-------

.. cpp:concept:: template <typename ZView, typename... FromViews> ZipView

    #. Refines the :cpp:concept:`template <typename V> View` concept.

    **Notation**

    .. cpp:type::   const_pixel_type = ZView::const_pixel_type
    .. cpp:var::    const_pixel_type cpix

    **Valid Expressions**

    - :cpp:expr:`cpix` models the :cpp:concept:`template <typename ZPix, typename... FromPixs> ZippedPixel` concept with `ZPix = ZView::const_pixel_type` and `FromPixs... = FromViews::const_pixel_type...`.

    **Possible implementation**

    .. code:: cpp

        template <  typename Z, typename... FromViews,
                    ZView = remove_cvref<ZV>>
        concept ZipView =   View<ZView> &&
                            View<FromViews>... &&
                            ZippedPixel<ZView::const_pixel_type, FromViews::const_pixel_type...>;


.. _concept-details-WritableZipView:

WritableZipView
---------------

.. cpp:concept:: template <typename WZView, typename... FromViews> WritableZipView

    #. Refines the :cpp:concept:`template <typename WV> WritableView` concept.
    #. Refines the :cpp:concept:`template <typename ZView, typename... FromViews> ZipView` concept.

    **Notation**

    .. cpp:type::   pixel_type = WZView::pixel_type
    .. cpp:var::    pixel_type pix

    **Valid Expressions**

    - :cpp:expr:`pix` models the :cpp:concept:`template <typename ZPix, typename... FromPixs> ZippedPixel` concept with `ZPix = WZView::pixel_type` and `FromPixs... = FromViews::const_pixel_type...`.

    **Possible implementation**

    .. code:: cpp

        template <  typename WZ, typename... FromViews,
                    WZView = remove_cvref<WZV>>
        concept WritableZipView =   WritableView<WZView> &&
                                    ZipView<WZView> &&
                                    View<FromViews>... &&
                                    ZippedPixel<WZView::pixel_type, FromViews::pixel_type...>;