Properties
==========

:cpp:include:`#include<hysj/graphs/properties.hpp>`

Properties map from element ids to other stuff.

.. cpp:namespace:: hysj

.. cpp:namespace-push:: graphs

In namespace :cpp:any:`graphs`:

.. cpp:function:: auto put(auto &p,auto i,auto &&v)

   | Hook to put value :cpp:expr:`v` to property of id :cpp:expr:`i`.
   |

.. cpp:function:: auto get(auto &p,auto i)

   | Hook to get property of :cpp:expr:`i`.

*Traits*

.. cpp:type:: template<class P,class I> traits::get_t

   *Let*
     .. cpp:var:: P p
		  I i
		  
   | Computes the return type of :cpp:expr:`get(p,i)`.
   |

.. cpp:function:: auto fill(auto &p,auto &&v)

   | Hook to write value :cpp:expr:`v` to all ids.
   |

.. cpp:concept:: template<typename P,typename I> concepts::property

   *Let*
     .. cpp:var:: P p
		  I i
		  traits::get_t<P,I> v

   *Requires*
     :cpp:expr:`graphs::get(p,i)`
     :cpp:expr:`graphs::put(p,i,v)`

   |

.. cpp:concept:: template<typename P,typename G,element_tag T> concepts::element_property

   *Requires*

     :cpp:expr:`concepts::property<P,traits::element_id<P,T>>`

   |

.. cpp:concept:: template<typename P,typename G,element_tag T,typename V> concepts::element_property_of

   *Requires*
   
     :cpp:expr:`concepts::element_property<P,G,T>`
     :cpp:expr:`std::convertible_to<traits::get_t<P,traits::element_id<G,T>>,V>`

   |

Builtin
-------

.. cpp:namespace-push:: builtin

In namespace :cpp:any:`builtin`:

Vector Properties
^^^^^^^^^^^^^^^^^

:cpp:include:`#include<hysj/graphs/builtin/vector_properties.hpp>`

Implementation of a property based on :cppref:`std::vector <container/vector>`.

.. cpp:function:: template<element_tag T,typename V> auto make_vector_property(constant_t<T> e,const graphs::concepts::elements<T> auto &g,V v)

   | Make a vector property for the elements of type :cpp:expr:`T` for the graph :cpp:expr:`g`, initializing the values with :cpp:expr:`v`.

*Shorthands*

.. rest-script::

   from hysj.graphs import ElementTag as Enum

   for e in Enum.__members__.values():
     print(f'.. cpp:var:: unspecified {e.name[0]}prop = bind(make_vector_property,{e.name}_tag)')

Constant Property
^^^^^^^^^^^^^^^^^

:cpp:include:`#include<hysj/graphs/builtin/constant_properties.hpp>`

Implementation of property with a constant value for any element.

.. cpp:struct:: template<typename T> constant_property

   .. cpp:member:: T value

      | Constant value.
      
   | Implements :cpp:concept:`concepts::element_property_of` for any element, graph and any :cpp:type:`U` convertible from :cpp:type:`T`.

Static Property
^^^^^^^^^^^^^^^

:cpp:include:`#include<hysj/graphs/builtin/static_properties.hpp>`

Implementation of property with a static value for any element.

.. cpp:struct:: template<auto T> static_property

   | Implements :cpp:concept:`concepts::element_property_of` for any element, graph and any :cpp:type:`U` convertible from :cpp:expr:`T`.

.. cpp:namespace-pop:: 

.. cpp:namespace-pop::