From 102f972beb58058309e3a0b68ef5661d7309b442 Mon Sep 17 00:00:00 2001 From: Alex Gabriel Date: Tue, 6 May 2025 17:50:43 +0200 Subject: [PATCH 1/2] adding understanding-logic documentation --- understanding-logic/concepts/agent.rst | 16 ++ understanding-logic/concepts/concept.rst | 16 ++ understanding-logic/concepts/datatype.rst | 191 ++++++++++++++++++ understanding-logic/concepts/engine.rst | 82 ++++++++ understanding-logic/concepts/exertion.rst | 68 +++++++ understanding-logic/concepts/extent.rst | 46 +++++ understanding-logic/concepts/formalism.rst | 22 ++ understanding-logic/concepts/index.rst | 106 ++++++++++ understanding-logic/concepts/modelet.rst | 106 ++++++++++ understanding-logic/concepts/origin.rst | 21 ++ understanding-logic/concepts/phenomenon.rst | 17 ++ understanding-logic/concepts/property.rst | 49 +++++ .../concepts/representation_class.rst | 11 + understanding-logic/concepts/requirement.rst | 36 ++++ .../concepts/spacetime_point.rst | 50 +++++ understanding-logic/concepts/strategy.rst | 20 ++ understanding-logic/concepts/template.rst | 81 ++++++++ understanding-logic/index.rst | 1 + understanding-logic/packages/index.rst | 2 + understanding-logic/usage/index.rst | 13 ++ 20 files changed, 954 insertions(+) create mode 100644 understanding-logic/concepts/agent.rst create mode 100644 understanding-logic/concepts/concept.rst create mode 100644 understanding-logic/concepts/datatype.rst create mode 100644 understanding-logic/concepts/engine.rst create mode 100644 understanding-logic/concepts/exertion.rst create mode 100644 understanding-logic/concepts/extent.rst create mode 100644 understanding-logic/concepts/formalism.rst create mode 100644 understanding-logic/concepts/index.rst create mode 100644 understanding-logic/concepts/modelet.rst create mode 100644 understanding-logic/concepts/origin.rst create mode 100644 understanding-logic/concepts/phenomenon.rst create mode 100644 understanding-logic/concepts/property.rst create mode 100644 understanding-logic/concepts/representation_class.rst create mode 100644 understanding-logic/concepts/requirement.rst create mode 100644 understanding-logic/concepts/spacetime_point.rst create mode 100644 understanding-logic/concepts/strategy.rst create mode 100644 understanding-logic/concepts/template.rst create mode 100644 understanding-logic/index.rst create mode 100644 understanding-logic/packages/index.rst create mode 100644 understanding-logic/usage/index.rst diff --git a/understanding-logic/concepts/agent.rst b/understanding-logic/concepts/agent.rst new file mode 100644 index 0000000..73949c6 --- /dev/null +++ b/understanding-logic/concepts/agent.rst @@ -0,0 +1,16 @@ +Types +===== + +.. _agent: + +**agent** ``$tType`` +-------------------- + +A **CoreSense** agent which may posess `engines `__ and +`modelets `__. + +!!! warning “Unimplemented” To be introduced later, as collective +awareness is considered. + +Source: ``fundamental-concepts.tff`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/understanding-logic/concepts/concept.rst b/understanding-logic/concepts/concept.rst new file mode 100644 index 0000000..0a50989 --- /dev/null +++ b/understanding-logic/concepts/concept.rst @@ -0,0 +1,16 @@ +Types +===== + +.. _concept: + +**concept** ``$tType`` +---------------------- + +An instance of a class of `phenomenon `__ in the agent’s +world model. + +A `concept <#concept>`__ is a `property `__ of a +`modelet `__. + +!!! example - chair - dog - the color pink - sunrise ###### Source: +``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/datatype.rst b/understanding-logic/concepts/datatype.rst new file mode 100644 index 0000000..9c1c75d --- /dev/null +++ b/understanding-logic/concepts/datatype.rst @@ -0,0 +1,191 @@ +Types +===== + +.. _datatype: + +**datatype** ``$tType`` +----------------------- + +A precise information encoding that is taken as granted. As the name +suggests, the fundamental types of data considered. + +!!! example - real number - uint8 - pixel ###### Source: +``fundamental-concepts.tff`` + +ROS 2 Interface builtins +======================== + +ROS 2 interfaces (messages, services, and actions) are +`formalisms `__ constructed from semantically named +builtin `datatypes <#datatype>`__ and arrays of these builtins. See the +ROS 2 +`documentation `__ +for more details. + +!!! important These individuals are not associated with a particular +semantic label. The intention (WIP) is to match a particular +`datatype <#datatype>`__ (the ``fieldtype``) and a +`concept `__ (the ``fieldname``) in some +`formalism `__ representing the ROS 2 interface. + +.. _ros2-msg-bool: + +**‘ROS2.msg.Bool’** ```datatype`` <#datatype>`__ +------------------------------------------------ + +The builtin ``bool`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-byte: + +**‘ROS2.msg.Byte’** ```datatype`` <#datatype>`__ +------------------------------------------------ + +The builtin ``byte`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-char: + +**‘ROS2.msg.Char’** ```datatype`` <#datatype>`__ +------------------------------------------------ + +The builtin ``char`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-float32: + +**‘ROS2.msg.Float32’** ```datatype`` <#datatype>`__ +--------------------------------------------------- + +The builtin ``float32`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-float64: + +**‘ROS2.msg.Float64’** ```datatype`` <#datatype>`__ +--------------------------------------------------- + +The builtin ``float64`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-int8: + +**‘ROS2.msg.Int8’** ```datatype`` <#datatype>`__ +------------------------------------------------ + +The builtin ``int8`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-uint8: + +**‘ROS2.msg.Uint8’** ```datatype`` <#datatype>`__ +------------------------------------------------- + +The builtin ``uint8`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-int16: + +**‘ROS2.msg.Int16’** ```datatype`` <#datatype>`__ +------------------------------------------------- + +The builtin ``int16`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-uint16: + +**‘ROS2.msg.Uint16’** ```datatype`` <#datatype>`__ +-------------------------------------------------- + +The builtin ``uin16`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-int32: + +**‘ROS2.msg.Int32’** ```datatype`` <#datatype>`__ +------------------------------------------------- + +The builtin ``int32`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-uint32: + +**‘ROS2.msg.Uint32’** ```datatype`` <#datatype>`__ +-------------------------------------------------- + +The builtin ``uint32`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-int64: + +**‘ROS2.msg.Int64’** ```datatype`` <#datatype>`__ +------------------------------------------------- + +The builtin ``int64`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-uint64: + +**‘ROS2.msg.Uint64’** ```datatype`` <#datatype>`__ +-------------------------------------------------- + +The builtin ``uint64`` field type of a ROS 2 interface. ###### Source: +``datatypes.tff`` + +.. _ros2-msg-string: + +**‘ROS2.msg.String’** ```datatype`` <#datatype>`__ +-------------------------------------------------- + +The builtin (unbounded) ``string`` field type of a ROS 2 interface. +These strings use 8-bit characters. ###### Source: ``datatypes.tff`` + +.. _ros2-msg-wstring: + +**‘ROS2.msg.Wstring’** ```datatype`` <#datatype>`__ +--------------------------------------------------- + +The builtin ``wstring`` field type of a ROS 2 interface. These strings +use 16-bit characters. ###### Source: ``datatypes.tff`` + +ROS 2 Interface arrays +====================== + +ROS 2 interfaces support arrays of builtins, optionally with a fixed or +bounded size. !!! warning Sizes of array datatypes are assumed to be +natural numbers. This is **NOT** enforced by the type checker or logic. + +.. _ros2-msg-bounded-string: + +**‘ROS2.msg.BoundedString’** ``(``\ **``$int``**\ ``>``\ ```datatype`` <#datatype>`__\ ``)`` +-------------------------------------------------------------------------------------------- + +A bounded ``string<=n`` field type of a ROS 2 interface. ``n`` is a +natural number. ###### Source: ``datatypes.tff`` + +.. _ros2-msg-unbounded-dynamic-array: + +**‘ROS2.msg.UnboundedDynamicArray’** ``(``\ ```datatype`` <#datatype>`__\ ``>``\ ```datatype`` <#datatype>`__\ ``)`` +-------------------------------------------------------------------------------------------------------------------- + +An array of any builtin with an unbouned size field type in a ROS 2 +interface. !!! example - ``char[]`` - ``float32[]`` ###### Source: +``datatypes.tff`` + +.. _ros2-msg-bounded-dynamic-array: + +**‘ROS2.msg.BoundedDynamicArray’** ``((``\ ```datatype`` <#datatype>`__\ ``*``\ **``$int``**\ ``) >``\ ```datatype`` <#datatype>`__\ ``)`` +------------------------------------------------------------------------------------------------------------------------------------------ + +A dynamic array of any builtin with a bounded size field type in a ROS 2 +interface. The size must be a natural number. !!! example - +``char[<=5]`` - ``float32[<=4]`` ###### Source: ``datatypes.tff`` + +.. _ros2-msg-static-array: + +**‘ROS2.msg.StaticArray’** ``((``\ ```datatype`` <#datatype>`__\ ``*``\ **``$int``**\ ``) >``\ ```datatype`` <#datatype>`__\ ``)`` +---------------------------------------------------------------------------------------------------------------------------------- + +A static array of any builtin with a fixed size field type in a ROS 2 +interface. The size must be a natural number. !!! example - ``char[5]`` +- ``float32[4]`` ###### Source: ``datatypes.tff`` diff --git a/understanding-logic/concepts/engine.rst b/understanding-logic/concepts/engine.rst new file mode 100644 index 0000000..fb3e8b9 --- /dev/null +++ b/understanding-logic/concepts/engine.rst @@ -0,0 +1,82 @@ +Types +===== + +.. _engine: + +**engine** ``$tType`` +--------------------- + +Does work within a **CoreSense** `agent `__ to produce +`modelets `__. + +- Takes multiple `modelets `__ as an input + `modelet_set `__ +- Uses semantic information to identify valid input modelet + `formalisms `__ + + - semantics could be external (part of the type definition) or + internal (modeled within the `modelet `__ itself) + +- Produces one output `modelet `__ + + - May or may not impart semantic meaning to the output + `modelet `__ + - May (re)define the output modelet `origin `__, + `concept `__, or characteristics + +- Has `exertion `__ characteristics + + - e.g. time delay, resource usage, power consumption + +!!! example - DroneStateEngine (see tff/tests/test-wind-estimation.tff) +- Input Model: - Modelet - formalism: IMU.msg - modelled concept: +inertia - Modelet - formalism: NavSatFix.msg - modelled concept: +geolocation - Output Modelet: - modelet - formalism: DroneState.msg - +modelled concept: drone_state ###### Source: +``engines-and-modelets.tff`` + +Relations +========= + +.. _interface_of: + +**interface_of** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```template_set`` `__\ ``)`` +--------------------------------------------------------------------------------------------------------------- + +An `engine <#engine>`__ requires a set of input +`modelets `__ which matches the +`template_set `__. ###### Source: +``engines-and-modelets.tff`` + +.. _output_modelet_formalism: + +**output_modelet_formalism** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```formalism`` `__\ ``)`` +------------------------------------------------------------------------------------------------------------ + +The `formalism `__ of an `engine <#engine>`__ output +`modelet `__. ###### Source: ``engines-and-modelets.tff`` + +.. _is_output_modelet_concept: + +**is_output_modelet_concept** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```phenomenon`` `__\ ``)`` +--------------------------------------------------------------------------------------------------------------- + +The `concept `__ of an `engine <#engine>`__ output +`modelet `__. ###### Source: ``engines-and-modelets.tff`` + +.. _output_property_of_e: + +**output_property_of_engine** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```property`` `__\ ``)`` +----------------------------------------------------------------------------------------------------------- + +The `property `__ an `engine <#engine>`__ imparts on its +output `modelet `__. ###### Source: ``properties.tff`` + +.. _engine_imparts_representation_class: + +**engine_imparts_representation_class** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```representation_class`` `__\ ``)`` +--------------------------------------------------------------------------------------------------------------------------------------------- + +The `representation_class `__ an +`engine <#engine>`__ imparts on its output `modelet `__. +###### Source: ``engines-and-modelets.tff`` diff --git a/understanding-logic/concepts/exertion.rst b/understanding-logic/concepts/exertion.rst new file mode 100644 index 0000000..cc5637c --- /dev/null +++ b/understanding-logic/concepts/exertion.rst @@ -0,0 +1,68 @@ +Relations +========= + +**inputs_match** ``((``\ ```modelet`` `__\ ``*``\ ```template`` `__\ ``) >``\ \*\*\ ``$o``\ \*\ ``)`` { #inputs_match data-toc-label=‘inputs_match’ } +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + +Check if a `modelet `__ matches a +`template `__. + +- Check if they are `formally equivalent <#formally_equivalent>`__ +- Check if the `modelet `__ contains *permissible* values + for each of the `properties `__ of + `requirements `__ of the `template `__. + ###### Source: ``engines-and-modelets.tff``, ``properties.tff`` + +.. _formally_equivalent: + +**formally_equivalent** ``((``\ ```template`` `__\ ``*``\ ```modelet`` `__\ ``) >``\ **``$o``**\ ``)`` +------------------------------------------------------------------------------------------------------------------------------- + +A `template `__ and a `modelet `__ share the +same *phenomenon* and `formalism `__. ###### Source: +``properties.tff`` + +.. _interfaces_match: + +**interfaces_match** ``((``\ ```modelet_set`` `__\ ``*``\ ```template_set`` `__\ ``) >``\ **``$o``**\ ``)`` +------------------------------------------------------------------------------------------------------------------------------------------------------------- + +Check if all of the `templates `__ in the +`template_set `__ have a corresponding +`modelet `__ in the `modelet_set `__ +with matching profile. + +- Check if they are `formally equivalent <#formally_equivalent>`__ +- Check if their `inputs match <#inputs_match>`__ ###### Source: + ``engines-and-modelets.tff``, ``properties.tff`` + +.. _exert: + +**exert** ``((``\ ```engine`` `__\ ``*``\ ```modelet_set`` `__\ ``*``\ ```modelet`` `__\ ``) >``\ **``$o``**\ ``)`` +------------------------------------------------------------------------------------------------------------------------------------------------------------------ + +Exert an `engine `__ on a +`modelet_set `__ to produce an output +`modelet `__. ###### Source: ``engines-and-modelets.tff`` + +.. _exertable: + +**exertable** ``((``\ ```modelet_set`` `__\ ``*``\ ```engine`` `__\ ``) >``\ **``$o``**\ ``)`` +--------------------------------------------------------------------------------------------------------------------------------- + +A `modelet_set `__ can be exerted by an +`engine `__ iff their `interfaces +match <#interfaces_match>`__. ###### Source: +``engines-and-modelets.tff`` + +.. raw:: html + + diff --git a/understanding-logic/concepts/extent.rst b/understanding-logic/concepts/extent.rst new file mode 100644 index 0000000..e0ce89f --- /dev/null +++ b/understanding-logic/concepts/extent.rst @@ -0,0 +1,46 @@ +Types +===== + +.. _extent: + +**extent** ``$tType`` +--------------------- + +A 4-dimensional size (3 space, 1 time). !!! note Not to be confused with +a 4-dimentional ```spacetime_point`` `__. ###### +Source: ``fundamental-concepts.tff`` + +Relations +========= + +.. _extent_width: + +**extent_width** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +----------------------------------------------------------------------------- + +The width of an (```extent`` <#extent>`__). ###### Source: +``fundamental-concepts.tff`` + +.. _extent_height: + +**extent_height** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +------------------------------------------------------------------------------ + +The height of an (```extent`` <#extent>`__). ###### Source: +``fundamental-concepts.tff`` + +.. _extent_depth: + +**extent_depth** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +----------------------------------------------------------------------------- + +The depth of an (```extent`` <#extent>`__). ###### Source: +``fundamental-concepts.tff`` + +.. _extent_duration: + +**extent_duration** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +-------------------------------------------------------------------------------- + +The duration of an (```extent`` <#extent>`__). ###### Source: +``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/formalism.rst b/understanding-logic/concepts/formalism.rst new file mode 100644 index 0000000..6f91001 --- /dev/null +++ b/understanding-logic/concepts/formalism.rst @@ -0,0 +1,22 @@ +Types +===== + +.. _formalism: + +**formalism** ``$tType`` +------------------------ + +The language and structure in which a `phenomenon `__ +could be described. Methods used to express `modelets `__; +class in the *Data Model*. + +- The information structure used to capture the + `concept `__ and `origin `__ +- Highlights some aspects of the *phenomenon* while hiding others +- Defines `engine `__ I/O compatibility and usability with + other models + +New `formalism <#formalism>`__ could be defined or old ones modified. + +!!! example - ROS message - Image format - Language grammar ###### +Source: Understanding presentation diff --git a/understanding-logic/concepts/index.rst b/understanding-logic/concepts/index.rst new file mode 100644 index 0000000..35944af --- /dev/null +++ b/understanding-logic/concepts/index.rst @@ -0,0 +1,106 @@ +Concepts +======== + +!!! danger These concepts are still in development and high susceptible +to change. Use the provided terms, definitions, and types with caution. + +The **Understanding System** (a.k.a Understanding Core) is a CoreSense +module for generating understanding within a *CoreSense* agent. The main +idea is to: !!! quote “Intuition” Find *strategies* of **Engine** +*exertions* to **create** required **Modelets**. + +!!! question “TODO” Add a map of the concepts or something more elegant +here… We should also include the triangle of meaning. + +Types +----- + +`agent `__ +~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/agent.rst:3:3” + +`datatype `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/datatype.rst:3:3” + +`engine `__ +~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/engine.rst:3:3” + +`exertion `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/exertion.rst:3:3” + +`extent `__ +~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/extent.rst:3:3” + +`formalism `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/formalism.rst:3:3” + +`modelet `__ +~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/modelet.rst:3:3” + +`modelet_set `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/modelet.rst:13:13” + +`origin `__ +~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/origin.rst:3:3” + +`phenomenon `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/phenomenon.rst:3:4” + +`property `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/property.rst:3:3” + +`requirement `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/requirement.rst:3:3” + +`representation_class `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/representation_class.rst:3:3” + +`spacetime_point `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/spacetime_point.rst:3:3” + +`strategy `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/strategy.rst:3:3” + +`template `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/template.rst:3:4” + +`template_set `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/template.rst:11:11” + +`concept `__ +~~~~~~~~~~~~~~~~~~~~~~~~ + +–8<– “docs/concepts/concept.rst:3:3” diff --git a/understanding-logic/concepts/modelet.rst b/understanding-logic/concepts/modelet.rst new file mode 100644 index 0000000..4307c55 --- /dev/null +++ b/understanding-logic/concepts/modelet.rst @@ -0,0 +1,106 @@ +Types +===== + +.. _modelet: + +**modelet** ``$tType`` +---------------------- + +Models a `phenomenon `__ as the *thought* in the triangle +of meaning. All modelets describe an instance of a +`concept `__, have an `origin `__, and are +modeled in a specific `formalism `__. + +- `Concept `__: the *phenomenon* of the + `modelet <#modelet>`__, an instance of a class in the world model. +- `Origin `__: the agent’s perspective on the *phenomenon* +- `Formalism `__: the representation of the *phenomenon* + ###### Source: ``engines-and-modelets.tff`` + +.. _modelet_set: + +**modelet_set** ``$tType`` +-------------------------- + +Some particular set of `modelets <#modelet>`__ which the has reasoner +assembled. Used to collect the inputs to an `engine `__. !!! +example - {m1, m2, m3} - {m2} - {} ###### Source: +``engines-and-modelets.tff`` + +Relations +========= + +.. _modelet_models_concept: + +**modelet_models_concept** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```phenomenon`` `__\ ``)`` +-------------------------------------------------------------------------------------------------------------- + +The `phenomenon `__ symbolizing the *phenomenon* of a +`modelet `__. !!! question “TODO” rename from ‘concept’ to +something else. ###### Source: ``engines-and-modelets.tff`` + +.. _formalism_of_modelet: + +**formalism_of_modelet** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```formalism`` `__\ ``)`` +---------------------------------------------------------------------------------------------------------- + +The `formalism `__ used by a `modelet <#modelet>`__ to +describe the *phenomenon*. ###### Source: ``engines-and-modelets.tff`` + +.. _modelet_creation_date: + +**modelet_creation_date** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ **``$real``**\ ``)`` +---------------------------------------------------------------------------------------- + +The date a `modelet <#modelet>`__ was created. !!! question “TODO” The +date is represented as a ``$real`` but we don’t make any assumptions +about what that number represents. Unix time? time since last restart? +seconds? This may be solved by integration with ``spacetime_point``. +###### Source: ``engines-and-modelets.tff`` + +.. _modelet_has_location: + +**modelet_has_location** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```spacetime_point`` `__\ ``)`` +---------------------------------------------------------------------------------------------------------------------- + +The time and spatial location a `modelet <#modelet>`__ refers to. +`Modelets `__ may have a specific temporal scope or make an +observation at a specific ```spacetime_point`` `__. +###### Source: ``engines-and-modelets.tff`` + +.. _modelet_has_extent: + +**modelet_has_extent** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```extent`` `__\ ``)`` +-------------------------------------------------------------------------------------------------- + +The time and spatial `extent `__ a `modelet <#modelet>`__ +refers to. `Modelets <#modelet>`__ may have an area/volume/duration of +reference. ###### Source: ``engines-and-modelets.tff`` + +.. _modelet_has_representation_class: + +**modelet_has_representation_class** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```representation_class`` `__\ ``)`` +-------------------------------------------------------------------------------------------------------------------------------------------- + +The `representation_class `__ a +`modelet <#modelet>`__\ ’s relation to its parents has after being +created by an `engine `__. !!! question “TODO” This looks +like it will turn out to be HOL. ###### Source: +``engines-and-modelets.tff`` + +.. _modelet_has_creator: + +**modelet_has_creator** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```engine`` `__\ ``)`` +--------------------------------------------------------------------------------------------------- + +The `engine `__ that created the `modelet <#modelet>`__. +###### Source: ``engines-and-modelets.tff`` + +.. _is_in_modelet_set: + +**is_in_modelet_set** ``((``\ ```modelet`` <#modelet>`__\ ``*``\ ```modelet_set`` <#modelet_set>`__\ ``) >``\ **``$o``**\ ``)`` +------------------------------------------------------------------------------------------------------------------------------- + +Check if a `modelet <#modelet>`__ is a member of a +`modelet_set <#modelet_set>`__. ###### Source: +``engines-and-modelets.tff`` diff --git a/understanding-logic/concepts/origin.rst b/understanding-logic/concepts/origin.rst new file mode 100644 index 0000000..5f78220 --- /dev/null +++ b/understanding-logic/concepts/origin.rst @@ -0,0 +1,21 @@ +Types +===== + +.. _origin: + +**origin** ``$tType`` +--------------------- + +An agent’s perspective on the *phenomenon* captured in a particular +`modelet `__. + +- Observation is *situated* in time and space +- Measured with sensors that have certain characteristics and + limitations + + - (inferred) physical quality (e.g. distance inferred from delay) + - resolution and frame rate + - reflections and transparencies could be misinterpreted + +Source: Understanding presentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/understanding-logic/concepts/phenomenon.rst b/understanding-logic/concepts/phenomenon.rst new file mode 100644 index 0000000..561b4a3 --- /dev/null +++ b/understanding-logic/concepts/phenomenon.rst @@ -0,0 +1,17 @@ +Types +===== + +.. _phenomenon: + +**phenomenon** ``$tType`` +------------------------- + +Some space or object or being or process in the real world that the +system represents using `modelets `__. + +- *Situated* in time and space +- May change over time +- Associated with a mission-dependent *meaning* + +!!! example - you - your office - your tea - your tea approaching room +temperature ###### Source: ``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/property.rst b/understanding-logic/concepts/property.rst new file mode 100644 index 0000000..f780f9b --- /dev/null +++ b/understanding-logic/concepts/property.rst @@ -0,0 +1,49 @@ +Types +===== + +.. _property: + +**property** ``$tType`` +----------------------- + +A specific characteristic of a `modelet `__ or +`engine `__. Multiple things can exhibit the same +`property <#property>`__. + +!!! example - color: red - age: 14 years ###### Source: +``properties.tff`` + +Relations +========= + +.. _has_value: + +**has_value** ``(``\ ```property`` <#property>`__\ ``>``\ **``$real``**\ ``)`` +------------------------------------------------------------------------------ + +The value of a certain `property <#property>`__. ###### Source: +``properties.tff`` + +.. _datatype_of_p: + +**datatype_of_property** ``(``\ ```property`` <#property>`__\ ``>``\ ```datatype`` `__\ ``)`` +---------------------------------------------------------------------------------------------------------- + +The `datatype `__ of a certain `property <#property>`__. +###### Source: ``properties.tff`` + +.. _is_property_of_m: + +**is_property_of_modelet** ``((``\ ```property`` <#property>`__\ ``*``\ ```modelet`` `__\ ``) >``\ **``$o``**\ ``)`` +-------------------------------------------------------------------------------------------------------------------------------- + +Check if a `modelet `__ is described by a certain +`property <#property>`__. ###### Source: ``properties.tff`` + +.. _is_property_of_e: + +**is_property_of_engine** ``((``\ ```property`` <#property>`__\ ``*``\ ```engine`` `__\ ``) >``\ **``$o``**\ ``)`` +----------------------------------------------------------------------------------------------------------------------------- + +Check if an `engine `__ is described by a certain +`property <#property>`__. ###### Source: ``properties.tff`` diff --git a/understanding-logic/concepts/representation_class.rst b/understanding-logic/concepts/representation_class.rst new file mode 100644 index 0000000..d307ed7 --- /dev/null +++ b/understanding-logic/concepts/representation_class.rst @@ -0,0 +1,11 @@ +Types +===== + +.. _representation_class: + +**representation_class** ``$tType`` +----------------------------------- + +The purpose of a `modelet `__ (extrinsic to itself) when +used by an `engine `__. Class in the *Processing/Modelling +Model*. ###### Source: ``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/requirement.rst b/understanding-logic/concepts/requirement.rst new file mode 100644 index 0000000..d382163 --- /dev/null +++ b/understanding-logic/concepts/requirement.rst @@ -0,0 +1,36 @@ +Types +===== + +.. _requirement: + +**requirement** ``$tType`` +-------------------------- + +A restriction on the `property `__ values that a +`template `__ may enforce on a `modelet `__. +###### Source: ``properties.tff`` + +Relations +========= + +.. _datatype_of_p: + +**datatype_of_requirement** ``(``\ ```requirement`` <#requirement>`__\ ``>``\ ```datatype`` `__\ ``)`` +------------------------------------------------------------------------------------------------------------------- + +The `datatype `__ of a certain +`requirement <#requirement>`__. ###### Source: ``properties.tff`` + +.. _is_permissible: + +**is_permissible** ``((``\ ```requirement`` <#requirement>`__\ ``*``\ **``$real``**\ ``) >``\ **``$o``**\ ``)`` +--------------------------------------------------------------------------------------------------------------- + +Check if a value is *permissible* under a certain +`requirement <#requirement>`__. ###### Source: ``properties.tff`` + +**is_part_of** ``((``\ ```requirement`` <#requirement>`__\ ``*``\ ```template`` `__\ ``) >``\ **``$o``**\ ``)`` { $is_part_of data-toc-label=‘is_part_of’ } +------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + +Check if a `requirement <#requirement>`__ is part of a +`template `__. ###### Source: ``properties.tff`` diff --git a/understanding-logic/concepts/spacetime_point.rst b/understanding-logic/concepts/spacetime_point.rst new file mode 100644 index 0000000..dcc76d0 --- /dev/null +++ b/understanding-logic/concepts/spacetime_point.rst @@ -0,0 +1,50 @@ +Types +===== + +.. _spacetime_point: + +**spacetime_point** ``$tType`` +------------------------------ + +4-dimensional coordinates (3 space, 1 time). !!! note Not to be confused +with a 4-dimentional ```extent`` `__. ###### Source: +``fundamental-concepts.tff`` + +Relations +========= + +.. _point_x: + +**point_x** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +------------------------------------------------------------------------------------------ + +The spatial ``x`` coordinate of a point in space and time +(```spacetime_point`` <#spacetime_point>`__). ###### Source: +``fundamental-concepts.tff`` + +.. _point_y: + +**point_y** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +------------------------------------------------------------------------------------------ + +The spatial ``y`` coordinate of a point in space and time +(```spacetime_point`` <#spacetime_point>`__). ###### Source: +``fundamental-concepts.tff`` + +.. _point_z: + +**point_z** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +------------------------------------------------------------------------------------------ + +The spatial ``z`` coordinate of a point in space and time +(```spacetime_point`` <#spacetime_point>`__). ###### Source: +``fundamental-concepts.tff`` + +.. _point_t: + +**point_t** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +------------------------------------------------------------------------------------------ + +The time ``t`` coordinate of a point in space and time +(```spacetime_point`` <#spacetime_point>`__). ###### Source: +``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/strategy.rst b/understanding-logic/concepts/strategy.rst new file mode 100644 index 0000000..8208c6d --- /dev/null +++ b/understanding-logic/concepts/strategy.rst @@ -0,0 +1,20 @@ +Types +===== + +.. _strategy: + +**strategy** ``((``\ ```modelet_set`` `__\ ``*``\ `modelet `__\ ``) >``\ **``$o``**\ ``)`` +-------------------------------------------------------------------------------------------------------------------------------------- + +A succession of `exertions `__ of `engines `__ +connects `modelets `__. `Strategies <#strategy>`__ +are transitive. + +- Must respect engine `requirements `__ +- Matches `modelet `__ *phenomenon* semantics to physical + reality + + - e.g. “on the living room table” to coordinates + +Source: ``transitive-strategies.tff`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/understanding-logic/concepts/template.rst b/understanding-logic/concepts/template.rst new file mode 100644 index 0000000..5c7d2b8 --- /dev/null +++ b/understanding-logic/concepts/template.rst @@ -0,0 +1,81 @@ +Types +===== + +.. _template: + +**template** ``$tType`` +----------------------- + +Describes the features that a single `modelet `__ should +have for an `engine `__ to accept it as input. + +- a semantic function signature +- `properties `__ and `requirements `__ of + `modelets `__ ###### Source: ``engines-and-modelets.tff`` + +.. _template_set: + +**template_set** ``$tType`` +--------------------------- + +Some particular set of `templates <#template>`__ which describe the +inputs to an `engine `__. !!! example - {t1, t2, t3} - {t2} - +{} ###### Source: ``engines-and-modelets.tff`` + +Relations +========= + +.. _template_has_concept_requirement: + +**template_has_concept_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```concept`` `__\ ``)`` +-------------------------------------------------------------------------------------------------------------------- + +The `concept `__ symbolizing the *phenomenon class* of a +`template `__. ###### Source: ``engines-and-modelets.tff`` + +.. _template_formalism_requirement: + +**template_formalism_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```formalism`` `__\ ``)`` +---------------------------------------------------------------------------------------------------------------------- + +The `formalism `__ this `template <#template>`__ expects +the *phenomenon* to be described by. ###### Source: +``engines-and-templates.tff`` + +.. _template_has_location_requirement: + +**template_has_location_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```spacetime_point`` `__\ ``)`` +------------------------------------------------------------------------------------------------------------------------------------- + +The time and spatial location a `template <#template>`__ refers to. A +`template `__ may have a specific temporal scope or expect +an observation at a specific +```spacetime_point`` `__. ###### Source: +``engines-and-modelets.tff`` + +.. _template_has_extent_requirement: + +**template_has_extent_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```extent`` `__\ ``)`` +----------------------------------------------------------------------------------------------------------------- + +The time and spatial `extent `__ a `template <#template>`__ +covers. A `template <#template>`__ may expect an area/volume/duration of +reference. ###### Source: ``engines-and-modelets.tff`` + +.. _template_has_creator_requirement: + +**template_has_creator_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```engine`` `__\ ``)`` +------------------------------------------------------------------------------------------------------------------ + +The `engine `__ a `template <#template>`__ requires a +`modelet `__ to have been created by. ###### Source: +``engines-and-modelets.tff`` + +.. _is_in_template_set: + +**is_in_template_set** ``((``\ ```template`` <#template>`__\ ``*``\ ```template_set`` <#template_set>`__\ ``) >``\ **``$o``**\ ``)`` +------------------------------------------------------------------------------------------------------------------------------------ + +Check if a `template <#template>`__ is a member of a +`template_set <#template_set>`__. ###### Source: +``engines-and-modelets.tff`` diff --git a/understanding-logic/index.rst b/understanding-logic/index.rst new file mode 100644 index 0000000..6542de7 --- /dev/null +++ b/understanding-logic/index.rst @@ -0,0 +1 @@ +–8<– “README.rst” diff --git a/understanding-logic/packages/index.rst b/understanding-logic/packages/index.rst new file mode 100644 index 0000000..1c81451 --- /dev/null +++ b/understanding-logic/packages/index.rst @@ -0,0 +1,2 @@ +Understanding Packages +====================== diff --git a/understanding-logic/usage/index.rst b/understanding-logic/usage/index.rst new file mode 100644 index 0000000..1ea03f5 --- /dev/null +++ b/understanding-logic/usage/index.rst @@ -0,0 +1,13 @@ +Usage and Installation +====================== + +The ``TFF`` models and tests can be run using the `latest +release `__ +or ``master`` branch of the +`Vampire `__ theorem prover. + +If you want to run the ``THF`` models, you need to either install the +`LEO-III `__ theorem prover or +build the Vampire ``hol`` branch from source using these +`instructions `__. +Make sure to add the ``-DCMAKE_BUILD_HOL=ON`` flag. From 4d7a38aea750bc1b17d074c19de4c5c1d6441017 Mon Sep 17 00:00:00 2001 From: Alex Gabriel Date: Tue, 6 May 2025 22:50:46 +0200 Subject: [PATCH 2/2] adding understanding logic documentation --- .gitignore | 1 + conf.py | 6 +- index.rst | 1 + understanding-logic/concepts/agent.rst | 7 +- understanding-logic/concepts/concept.rst | 15 +- understanding-logic/concepts/datatype.rst | 187 ++++++++++-------- understanding-logic/concepts/engine.rst | 102 +++++----- understanding-logic/concepts/exertion.rst | 96 ++++----- understanding-logic/concepts/extent.rst | 34 ++-- understanding-logic/concepts/formalism.rst | 19 +- understanding-logic/concepts/index.rst | 177 +++++++++++------ understanding-logic/concepts/modelet.rst | 108 +++++----- understanding-logic/concepts/origin.rst | 7 +- understanding-logic/concepts/phenomenon.rst | 13 +- understanding-logic/concepts/property.rst | 48 +++-- .../concepts/representation_class.rst | 6 +- understanding-logic/concepts/requirement.rst | 35 ++-- .../concepts/spacetime_point.rst | 43 ++-- understanding-logic/concepts/strategy.rst | 15 +- understanding-logic/concepts/template.rst | 82 ++++---- understanding-logic/index.rst | 14 +- 21 files changed, 578 insertions(+), 438 deletions(-) diff --git a/.gitignore b/.gitignore index 372b93d..4706036 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .vscode/ _build/ +venv/ diff --git a/conf.py b/conf.py index 612d387..f8e4ffc 100644 --- a/conf.py +++ b/conf.py @@ -30,7 +30,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['breathe', 'sphinx.ext.graphviz', 'sphinxcontrib.plantuml', 'sphinx.ext.extlinks'] +extensions = ['breathe', 'sphinx.ext.graphviz', 'sphinxcontrib.plantuml', 'sphinx.ext.extlinks', 'sphinx.ext.autosummary', 'sphinx.ext.autodoc'] graphviz_output_format='png' graphviz_dot_args=[ @@ -75,12 +75,12 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build','_themes','scripts' ] +exclude_patterns = ['_build','_themes','scripts', 'venv' ] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/index.rst b/index.rst index 2c047a6..6129694 100644 --- a/index.rst +++ b/index.rst @@ -21,6 +21,7 @@ CoreSense Project (CoreSense in short) is a project... TBD opensourecommunity/index.rst build_instructions/index.rst design/index.rst + understanding-logic/index.rst tutorials/index.rst testbeds/index.rst demos/index.rst diff --git a/understanding-logic/concepts/agent.rst b/understanding-logic/concepts/agent.rst index 73949c6..abf0621 100644 --- a/understanding-logic/concepts/agent.rst +++ b/understanding-logic/concepts/agent.rst @@ -6,11 +6,8 @@ Types **agent** ``$tType`` -------------------- -A **CoreSense** agent which may posess `engines `__ and -`modelets `__. +A **CoreSense** agent which may posess `engines `_ and `modelets `_. -!!! warning “Unimplemented” To be introduced later, as collective -awareness is considered. +.. warning:: “Unimplemented” To be introduced later, as collective awareness is considered. Source: ``fundamental-concepts.tff`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/understanding-logic/concepts/concept.rst b/understanding-logic/concepts/concept.rst index 0a50989..f62dc6c 100644 --- a/understanding-logic/concepts/concept.rst +++ b/understanding-logic/concepts/concept.rst @@ -6,11 +6,14 @@ Types **concept** ``$tType`` ---------------------- -An instance of a class of `phenomenon `__ in the agent’s -world model. +An instance of a class of `phenomenon `_ in the agent’s world model. -A `concept <#concept>`__ is a `property `__ of a -`modelet `__. +A `concept <#concept>`_ is a `property `_ of a `modelet `_. -!!! example - chair - dog - the color pink - sunrise ###### Source: -``fundamental-concepts.tff`` +.. example:: + - chair + - dog + - the color pink + - sunrise + +Source: ``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/datatype.rst b/understanding-logic/concepts/datatype.rst index 9c1c75d..921f298 100644 --- a/understanding-logic/concepts/datatype.rst +++ b/understanding-logic/concepts/datatype.rst @@ -6,186 +6,211 @@ Types **datatype** ``$tType`` ----------------------- -A precise information encoding that is taken as granted. As the name -suggests, the fundamental types of data considered. +A precise information encoding that is taken as granted. As the name suggests, the fundamental types of data considered. -!!! example - real number - uint8 - pixel ###### Source: -``fundamental-concepts.tff`` +.. example:: + - real number + - uint8 + - pixel + +Source: ``fundamental-concepts.tff`` ROS 2 Interface builtins ======================== -ROS 2 interfaces (messages, services, and actions) are -`formalisms `__ constructed from semantically named -builtin `datatypes <#datatype>`__ and arrays of these builtins. See the -ROS 2 -`documentation `__ +ROS 2 interfaces (messages, services, and actions) are `formalisms `_ constructed from semantically named builtin `datatypes <#datatype>`_ and arrays of these builtins. See the ROS 2 `documentation `_ for more details. -!!! important These individuals are not associated with a particular -semantic label. The intention (WIP) is to match a particular -`datatype <#datatype>`__ (the ``fieldtype``) and a -`concept `__ (the ``fieldname``) in some -`formalism `__ representing the ROS 2 interface. +.. important:: + These individuals are not associated with a particular semantic label. The intention (WIP) is to match a particular `datatype <#datatype>`_ (the ``fieldtype``) and a `concept `_ (the ``fieldname``) in some `formalism `_ representing the ROS 2 interface. .. _ros2-msg-bool: -**‘ROS2.msg.Bool’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Bool’** `datatype <#datatype>`_ ------------------------------------------------ -The builtin ``bool`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``bool`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-byte: -**‘ROS2.msg.Byte’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Byte’** `datatype <#datatype>`_ ------------------------------------------------ -The builtin ``byte`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``byte`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-char: -**‘ROS2.msg.Char’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Char’** `datatype <#datatype>`_ ------------------------------------------------ -The builtin ``char`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``char`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-float32: -**‘ROS2.msg.Float32’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Float32’** `datatype <#datatype>`_ --------------------------------------------------- -The builtin ``float32`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``float32`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-float64: -**‘ROS2.msg.Float64’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Float64’** `datatype <#datatype>`_ --------------------------------------------------- -The builtin ``float64`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``float64`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-int8: -**‘ROS2.msg.Int8’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Int8’** `datatype <#datatype>`_ ------------------------------------------------ -The builtin ``int8`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``int8`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-uint8: -**‘ROS2.msg.Uint8’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Uint8’** `datatype <#datatype>`_ ------------------------------------------------- -The builtin ``uint8`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``uint8`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-int16: -**‘ROS2.msg.Int16’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Int16’** `datatype <#datatype>`_ ------------------------------------------------- -The builtin ``int16`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``int16`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-uint16: -**‘ROS2.msg.Uint16’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Uint16’** `datatype <#datatype>`_ -------------------------------------------------- -The builtin ``uin16`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``uin16`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-int32: -**‘ROS2.msg.Int32’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Int32’** `datatype <#datatype>`_ ------------------------------------------------- -The builtin ``int32`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``int32`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-uint32: -**‘ROS2.msg.Uint32’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Uint32’** `datatype <#datatype>`_ -------------------------------------------------- -The builtin ``uint32`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``uint32`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-int64: -**‘ROS2.msg.Int64’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Int64’** `datatype <#datatype>`_ ------------------------------------------------- -The builtin ``int64`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``int64`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-uint64: -**‘ROS2.msg.Uint64’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Uint64’** `datatype <#datatype>`_ -------------------------------------------------- -The builtin ``uint64`` field type of a ROS 2 interface. ###### Source: -``datatypes.tff`` +The builtin ``uint64`` field type of a ROS 2 interface. + +Source: ``datatypes.tff`` .. _ros2-msg-string: -**‘ROS2.msg.String’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.String’** `datatype <#datatype>`_ -------------------------------------------------- -The builtin (unbounded) ``string`` field type of a ROS 2 interface. -These strings use 8-bit characters. ###### Source: ``datatypes.tff`` +The builtin (unbounded) ``string`` field type of a ROS 2 interface. These strings use 8-bit characters. + +Source: ``datatypes.tff`` .. _ros2-msg-wstring: -**‘ROS2.msg.Wstring’** ```datatype`` <#datatype>`__ +**‘ROS2.msg.Wstring’** `datatype <#datatype>`_ --------------------------------------------------- -The builtin ``wstring`` field type of a ROS 2 interface. These strings -use 16-bit characters. ###### Source: ``datatypes.tff`` +The builtin ``wstring`` field type of a ROS 2 interface. These strings use 16-bit characters. + +Source: ``datatypes.tff`` ROS 2 Interface arrays ====================== -ROS 2 interfaces support arrays of builtins, optionally with a fixed or -bounded size. !!! warning Sizes of array datatypes are assumed to be -natural numbers. This is **NOT** enforced by the type checker or logic. +ROS 2 interfaces support arrays of builtins, optionally with a fixed or bounded size. + +.. warning:: + Sizes of array datatypes are assumed to be natural numbers. This is **NOT** enforced by the type checker or logic. .. _ros2-msg-bounded-string: -**‘ROS2.msg.BoundedString’** ``(``\ **``$int``**\ ``>``\ ```datatype`` <#datatype>`__\ ``)`` --------------------------------------------------------------------------------------------- +**‘ROS2.msg.BoundedString’** ( **$int** > `datatype <#datatype>`_ ) +------------------------------------------------------------------- + +A bounded ``string<=n`` field type of a ROS 2 interface. ``n`` is a natural number. -A bounded ``string<=n`` field type of a ROS 2 interface. ``n`` is a -natural number. ###### Source: ``datatypes.tff`` +Source: ``datatypes.tff`` .. _ros2-msg-unbounded-dynamic-array: -**‘ROS2.msg.UnboundedDynamicArray’** ``(``\ ```datatype`` <#datatype>`__\ ``>``\ ```datatype`` <#datatype>`__\ ``)`` --------------------------------------------------------------------------------------------------------------------- +**‘ROS2.msg.UnboundedDynamicArray’** ( `datatype <#datatype>`_ > `datatype <#datatype>`_ ) +------------------------------------------------------------------------------------------ -An array of any builtin with an unbouned size field type in a ROS 2 -interface. !!! example - ``char[]`` - ``float32[]`` ###### Source: -``datatypes.tff`` +An array of any builtin with an unbouned size field type in a ROS 2 interface. + +.. example:: + - ``char[]`` + - ``float32[]`` + +Source: ``datatypes.tff`` .. _ros2-msg-bounded-dynamic-array: -**‘ROS2.msg.BoundedDynamicArray’** ``((``\ ```datatype`` <#datatype>`__\ ``*``\ **``$int``**\ ``) >``\ ```datatype`` <#datatype>`__\ ``)`` ------------------------------------------------------------------------------------------------------------------------------------------- +**‘ROS2.msg.BoundedDynamicArray’** (( `datatype <#datatype>`_ * **$int** ) > `datatype <#datatype>`_ ) +------------------------------------------------------------------------------------------------------ + +A dynamic array of any builtin with a bounded size field type in a ROS 2 interface. The size must be a natural number. -A dynamic array of any builtin with a bounded size field type in a ROS 2 -interface. The size must be a natural number. !!! example - -``char[<=5]`` - ``float32[<=4]`` ###### Source: ``datatypes.tff`` +.. example:: + -``char[<=5]`` + - ``float32[<=4]`` + +Source: ``datatypes.tff`` .. _ros2-msg-static-array: -**‘ROS2.msg.StaticArray’** ``((``\ ```datatype`` <#datatype>`__\ ``*``\ **``$int``**\ ``) >``\ ```datatype`` <#datatype>`__\ ``)`` ----------------------------------------------------------------------------------------------------------------------------------- +**‘ROS2.msg.StaticArray’** (( `datatype <#datatype>`_ * **$int** ) > `datatype <#datatype>`_ ) +---------------------------------------------------------------------------------------------- + +A static array of any builtin with a fixed size field type in a ROS 2 interface. The size must be a natural number. + +.. example:: + - ``char[5]`` + - ``float32[4]`` -A static array of any builtin with a fixed size field type in a ROS 2 -interface. The size must be a natural number. !!! example - ``char[5]`` -- ``float32[4]`` ###### Source: ``datatypes.tff`` +Source: ``datatypes.tff`` diff --git a/understanding-logic/concepts/engine.rst b/understanding-logic/concepts/engine.rst index fb3e8b9..264ceea 100644 --- a/understanding-logic/concepts/engine.rst +++ b/understanding-logic/concepts/engine.rst @@ -1,82 +1,94 @@ Types ===== -.. _engine: + **engine** ``$tType`` --------------------- -Does work within a **CoreSense** `agent `__ to produce -`modelets `__. +Does work within a **CoreSense** `agent `_ to produce `modelets `_. -- Takes multiple `modelets `__ as an input - `modelet_set `__ -- Uses semantic information to identify valid input modelet - `formalisms `__ +- Takes multiple `modelets `_ as an input `modelet_set `_ +- Uses semantic information to identify valid input modelet `formalisms `_ - - semantics could be external (part of the type definition) or - internal (modeled within the `modelet `__ itself) + - semantics could be external (part of the type definition) or internal (modeled within the `modelet `_ itself) +- Produces one output `modelet `_ -- Produces one output `modelet `__ + - May or may not impart semantic meaning to the output `modelet `_ + - May (re)define the output modelet `origin `_, `concept `_, or characteristics +- Has `exertion `_ characteristics - - May or may not impart semantic meaning to the output - `modelet `__ - - May (re)define the output modelet `origin `__, - `concept `__, or characteristics + - e.g. time delay, resource usage, power consumption -- Has `exertion `__ characteristics +.. admonition:: Example - - e.g. time delay, resource usage, power consumption + - DroneStateEngine (see tff/tests/test-wind-estimation.tff) + + - Input Model: + + - Modelet + + - formalism: IMU.msg + - modelled concept: inertia + + - Modelet: + + - formalism: NavSatFix.msg + - modelled concept: geolocation + + - Output Modelet: + + - modelet: + + - formalism: DroneState.msg + - modelled concept: drone_state -!!! example - DroneStateEngine (see tff/tests/test-wind-estimation.tff) -- Input Model: - Modelet - formalism: IMU.msg - modelled concept: -inertia - Modelet - formalism: NavSatFix.msg - modelled concept: -geolocation - Output Modelet: - modelet - formalism: DroneState.msg - -modelled concept: drone_state ###### Source: -``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` Relations ========= .. _interface_of: -**interface_of** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```template_set`` `__\ ``)`` ---------------------------------------------------------------------------------------------------------------- +**interface_of** ( `engine <#engine>`_ > `template_set `_ ) +-------------------------------------------------------------------------------------- -An `engine <#engine>`__ requires a set of input -`modelets `__ which matches the -`template_set `__. ###### Source: -``engines-and-modelets.tff`` +An `engine <#engine>`_ requires a set of input `modelets `_ which matches the `template_set `_. + +Source: ``engines-and-modelets.tff`` .. _output_modelet_formalism: -**output_modelet_formalism** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```formalism`` `__\ ``)`` ------------------------------------------------------------------------------------------------------------- +**output_modelet_formalism** ( `engine <#engine>`_ > `formalism `_ ) +------------------------------------------------------------------------------------ + +The `formalism `_ of an `engine <#engine>`_ output `modelet `_. -The `formalism `__ of an `engine <#engine>`__ output -`modelet `__. ###### Source: ``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` .. _is_output_modelet_concept: -**is_output_modelet_concept** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```phenomenon`` `__\ ``)`` ---------------------------------------------------------------------------------------------------------------- +**is_output_modelet_concept** ( `engine <#engine>`_ > `phenomenon `_ ) +--------------------------------------------------------------------------------------- + +The `concept `_ of an `engine <#engine>`_ output `modelet `_. -The `concept `__ of an `engine <#engine>`__ output -`modelet `__. ###### Source: ``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` .. _output_property_of_e: -**output_property_of_engine** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```property`` `__\ ``)`` ------------------------------------------------------------------------------------------------------------ +**output_property_of_engine** ( `engine <#engine>`_ > `property `_ ) +----------------------------------------------------------------------------------- -The `property `__ an `engine <#engine>`__ imparts on its -output `modelet `__. ###### Source: ``properties.tff`` +The `property `_ an `engine <#engine>`_ imparts on its output `modelet `_. + +Source: ``properties.tff`` .. _engine_imparts_representation_class: -**engine_imparts_representation_class** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```representation_class`` `__\ ``)`` ---------------------------------------------------------------------------------------------------------------------------------------------- +**engine_imparts_representation_class** ( `engine <#engine>`_ > `representation_class `_ ) +--------------------------------------------------------------------------------------------------------------------- + +The `representation_class `_ an `engine <#engine>`_ imparts on its output `modelet `_. -The `representation_class `__ an -`engine <#engine>`__ imparts on its output `modelet `__. -###### Source: ``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` diff --git a/understanding-logic/concepts/exertion.rst b/understanding-logic/concepts/exertion.rst index cc5637c..52e5927 100644 --- a/understanding-logic/concepts/exertion.rst +++ b/understanding-logic/concepts/exertion.rst @@ -1,68 +1,70 @@ + + + + + + Relations ========= -**inputs_match** ``((``\ ```modelet`` `__\ ``*``\ ```template`` `__\ ``) >``\ \*\*\ ``$o``\ \*\ ``)`` { #inputs_match data-toc-label=‘inputs_match’ } ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +.. _inputs_match: + +**inputs_match** (( `modelet `_ * `template `_ ) > **$o** ) +---------------------------------------------------------------------------------------- -Check if a `modelet `__ matches a -`template `__. +Check if a `modelet `_ matches a `template `_. -- Check if they are `formally equivalent <#formally_equivalent>`__ -- Check if the `modelet `__ contains *permissible* values - for each of the `properties `__ of - `requirements `__ of the `template `__. - ###### Source: ``engines-and-modelets.tff``, ``properties.tff`` +- Check if they are `formally equivalent <#formally_equivalent>`_ +- Check if the `modelet `_ contains *permissible* values + for each of the `properties `_ of `requirements `_ of the `template `_. + +Source: ``engines-and-modelets.tff``, ``properties.tff`` .. _formally_equivalent: -**formally_equivalent** ``((``\ ```template`` `__\ ``*``\ ```modelet`` `__\ ``) >``\ **``$o``**\ ``)`` -------------------------------------------------------------------------------------------------------------------------------- +**formally_equivalent** (( `template `_ * `modelet `_ ) > **$o** ) +----------------------------------------------------------------------------------------------- + +A `template `_ and a `modelet `_ share the same *phenomenon* and `formalism `_. -A `template `__ and a `modelet `__ share the -same *phenomenon* and `formalism `__. ###### Source: -``properties.tff`` +Source: ``properties.tff`` .. _interfaces_match: -**interfaces_match** ``((``\ ```modelet_set`` `__\ ``*``\ ```template_set`` `__\ ``) >``\ **``$o``**\ ``)`` -------------------------------------------------------------------------------------------------------------------------------------------------------------- +**interfaces_match** (( `modelet_set `_ * `template_set `_ ) > **$o** ) +--------------------------------------------------------------------------------------------------------------------------- -Check if all of the `templates `__ in the -`template_set `__ have a corresponding -`modelet `__ in the `modelet_set `__ -with matching profile. +Check if all of the `templates `_ in the `template_set `_ have a corresponding `modelet `_ in the `modelet_set `_ with matching profile. -- Check if they are `formally equivalent <#formally_equivalent>`__ -- Check if their `inputs match <#inputs_match>`__ ###### Source: - ``engines-and-modelets.tff``, ``properties.tff`` +- Check if they are `formally equivalent <#formally_equivalent>`_ +- Check if their `inputs match <#inputs_match>`_ + +Source: ``engines-and-modelets.tff``, ``properties.tff`` .. _exert: -**exert** ``((``\ ```engine`` `__\ ``*``\ ```modelet_set`` `__\ ``*``\ ```modelet`` `__\ ``) >``\ **``$o``**\ ``)`` ------------------------------------------------------------------------------------------------------------------------------------------------------------------- +**exert** (( `engine `_ * `modelet_set `_ * `modelet `_ ) > **$o** ) +------------------------------------------------------------------------------------------------------------------------ + +Exert an `engine `_ on a `modelet_set `_ to produce an output `modelet `_. -Exert an `engine `__ on a -`modelet_set `__ to produce an output -`modelet `__. ###### Source: ``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` .. _exertable: -**exertable** ``((``\ ```modelet_set`` `__\ ``*``\ ```engine`` `__\ ``) >``\ **``$o``**\ ``)`` ---------------------------------------------------------------------------------------------------------------------------------- - -A `modelet_set `__ can be exerted by an -`engine `__ iff their `interfaces -match <#interfaces_match>`__. ###### Source: -``engines-and-modelets.tff`` - -.. raw:: html - - +**exertable** (( `modelet_set `_ * `engine `_ ) > **$o** ) +------------------------------------------------------------------------------------------------ + +A `modelet_set `_ can be exerted by an `engine `_ iff their `interfaces match <#interfaces_match>`_. + +Source: ``engines-and-modelets.tff`` + +.. _exertion: + +**exertion** (( `engine `_ * `modelet_set `_ * `modelet `_ * `modelet_set `_ ) > `modelet_set `_ ) +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + + +The act of exerting an `engine `_ on a `modelet_set `_, resulting in a `modelet `_, in defined state of knowledge, resulting in the addition of the output modelet to that state of knowledge. + +Source: ``understanding-calculus.tff`` diff --git a/understanding-logic/concepts/extent.rst b/understanding-logic/concepts/extent.rst index e0ce89f..053e95f 100644 --- a/understanding-logic/concepts/extent.rst +++ b/understanding-logic/concepts/extent.rst @@ -1,13 +1,13 @@ Types ===== -.. _extent: + **extent** ``$tType`` --------------------- -A 4-dimensional size (3 space, 1 time). !!! note Not to be confused with -a 4-dimentional ```spacetime_point`` `__. ###### +A 4-dimensional size (3 space, 1 time). .. note:: Not to be confused with a 4-dimentional `spacetime_point `_. + Source: ``fundamental-concepts.tff`` Relations @@ -15,32 +15,36 @@ Relations .. _extent_width: -**extent_width** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +**extent_width** ( `extent <#extent>`_ > **$real** ) ----------------------------------------------------------------------------- -The width of an (```extent`` <#extent>`__). ###### Source: -``fundamental-concepts.tff`` +The width of an (`extent <#extent>`_). + +Source: ``fundamental-concepts.tff`` .. _extent_height: -**extent_height** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +**extent_height** ( `extent <#extent>`_ > **$real** ) ------------------------------------------------------------------------------ -The height of an (```extent`` <#extent>`__). ###### Source: -``fundamental-concepts.tff`` +The height of an (`extent <#extent>`_). + +Source: ``fundamental-concepts.tff`` .. _extent_depth: -**extent_depth** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +**extent_depth** ( `extent <#extent>`_ > **$real** ) ----------------------------------------------------------------------------- -The depth of an (```extent`` <#extent>`__). ###### Source: -``fundamental-concepts.tff`` +The depth of an (`extent <#extent>`_). + +Source: ``fundamental-concepts.tff`` .. _extent_duration: -**extent_duration** ``(``\ ```extent`` <#extent>`__\ ``>``\ **``$real``**\ ``)`` +**extent_duration** ( `extent <#extent>`_ > **$real** ) -------------------------------------------------------------------------------- -The duration of an (```extent`` <#extent>`__). ###### Source: -``fundamental-concepts.tff`` +The duration of an (`extent <#extent>`_). + +Source: ``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/formalism.rst b/understanding-logic/concepts/formalism.rst index 6f91001..5c33dea 100644 --- a/understanding-logic/concepts/formalism.rst +++ b/understanding-logic/concepts/formalism.rst @@ -6,17 +6,18 @@ Types **formalism** ``$tType`` ------------------------ -The language and structure in which a `phenomenon `__ -could be described. Methods used to express `modelets `__; -class in the *Data Model*. +The language and structure in which a `phenomenon `_ could be described. Methods used to express `modelets `_; class in the *Data Model*. -- The information structure used to capture the - `concept `__ and `origin `__ +- The information structure used to capture the `concept `_ and `origin `_ - Highlights some aspects of the *phenomenon* while hiding others -- Defines `engine `__ I/O compatibility and usability with - other models +- Defines `engine `_ I/O compatibility and usability with other models -New `formalism <#formalism>`__ could be defined or old ones modified. +New `formalism <#formalism>`_ could be defined or old ones modified. + +.. admonition:: Example + + - ROS message + - Image format + - Language grammar -!!! example - ROS message - Image format - Language grammar ###### Source: Understanding presentation diff --git a/understanding-logic/concepts/index.rst b/understanding-logic/concepts/index.rst index 35944af..741c996 100644 --- a/understanding-logic/concepts/index.rst +++ b/understanding-logic/concepts/index.rst @@ -1,106 +1,165 @@ Concepts ======== -!!! danger These concepts are still in development and high susceptible -to change. Use the provided terms, definitions, and types with caution. +.. danger:: + + These concepts are still in development and highly susceptible to change. Use the provided terms, definitions, and types with caution. The **Understanding System** (a.k.a Understanding Core) is a CoreSense module for generating understanding within a *CoreSense* agent. The main -idea is to: !!! quote “Intuition” Find *strategies* of **Engine** +idea is to: .. quote:: Intuition Find *strategies* of **Engine** *exertions* to **create** required **Modelets**. -!!! question “TODO” Add a map of the concepts or something more elegant -here… We should also include the triangle of meaning. +.. admonition:: TODO + + Add a map of the concepts or something more elegant here… We should also include the triangle of meaning. Types ----- -`agent `__ -~~~~~~~~~~~~~~~~~~~~ +`agent `_ +~~~~~~~~~~~~~~~~~~~~~ + +.. include:: agent.rst + :start-line: 8 + :end-line: 9 + +`datatype `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: datatype.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/agent.rst:3:3” +`engine `_ +~~~~~~~~~~~~~~~~~~~~~~~ -`datatype `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: engine.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/datatype.rst:3:3” +`exertion `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`engine `__ -~~~~~~~~~~~~~~~~~~~~~~ +.. include:: exertion.rst + :start-line: 67 + :end-line: 68 -–8<– “docs/concepts/engine.rst:3:3” +`extent `_ +~~~~~~~~~~~~~~~~~~~~~~~ -`exertion `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: extent.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/exertion.rst:3:3” +`formalism `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`extent `__ -~~~~~~~~~~~~~~~~~~~~~~ +.. include:: formalism.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/extent.rst:3:3” +`modelet `_ +~~~~~~~~~~~~~~~~~~~~~~~~~ -`formalism `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: modelet.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/formalism.rst:3:3” +`modelet_set `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`modelet `__ -~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: modelet.rst + :start-line: 21 + :end-line: 22 -–8<– “docs/concepts/modelet.rst:3:3” +`origin `_ +~~~~~~~~~~~~~~~~~~~~~~~ -`modelet_set `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: origin.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/modelet.rst:13:13” +`phenomenon `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`origin `__ -~~~~~~~~~~~~~~~~~~~~~~ +.. include:: phenomenon.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/origin.rst:3:3” +`property `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`phenomenon `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: property.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/phenomenon.rst:3:4” +`requirement `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`property `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: requirement.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/property.rst:3:3” +`representation_class `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`requirement `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: representation_class.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/requirement.rst:3:3” +`spacetime_point `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`representation_class `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: spacetime_point.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/representation_class.rst:3:3” +`strategy `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`spacetime_point `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: strategy.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/spacetime_point.rst:3:3” +`template `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`strategy `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: template.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/strategy.rst:3:3” +`template_set `_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`template `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: template.rst + :start-line: 19 + :end-line: 20 -–8<– “docs/concepts/template.rst:3:4” +`concept `_ +~~~~~~~~~~~~~~~~~~~~~~~~~ -`template_set `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: concept.rst + :start-line: 8 + :end-line: 9 -–8<– “docs/concepts/template.rst:11:11” -`concept `__ -~~~~~~~~~~~~~~~~~~~~~~~~ +.. toctree:: + :hidden: -–8<– “docs/concepts/concept.rst:3:3” + agent.rst + concept.rst + datatype.rst + engine.rst + exertion.rst + extent.rst + formalism.rst + modelet.rst + origin.rst + phenomenon.rst + property.rst + representation_class.rst + requirement.rst + spacetime_point.rst + strategy.rst + template.rst diff --git a/understanding-logic/concepts/modelet.rst b/understanding-logic/concepts/modelet.rst index 4307c55..c43e931 100644 --- a/understanding-logic/concepts/modelet.rst +++ b/understanding-logic/concepts/modelet.rst @@ -1,106 +1,114 @@ Types ===== -.. _modelet: + **modelet** ``$tType`` ---------------------- -Models a `phenomenon `__ as the *thought* in the triangle -of meaning. All modelets describe an instance of a -`concept `__, have an `origin `__, and are -modeled in a specific `formalism `__. +Models a `phenomenon `_ as the *thought* in the triangle of meaning. All modelets describe an instance of a `concept `_, have an `origin `_, and are modeled in a specific `formalism `_. + +- `Concept `_: the *phenomenon* of the + `modelet `_, an instance of a class in the world model. +- `Origin `_: the agent’s perspective on the *phenomenon* +- `Formalism `_: the representation of the *phenomenon* -- `Concept `__: the *phenomenon* of the - `modelet <#modelet>`__, an instance of a class in the world model. -- `Origin `__: the agent’s perspective on the *phenomenon* -- `Formalism `__: the representation of the *phenomenon* - ###### Source: ``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` -.. _modelet_set: **modelet_set** ``$tType`` -------------------------- -Some particular set of `modelets <#modelet>`__ which the has reasoner -assembled. Used to collect the inputs to an `engine `__. !!! -example - {m1, m2, m3} - {m2} - {} ###### Source: -``engines-and-modelets.tff`` +Some particular set of `modelets `_ which the reasoner has assembled. Used to collect the inputs to an `engine `_. + +.. admonition:: Example + + + - {m1, m2, m3} + - {m2} + - {} + +Source: ``engines-and-modelets.tff`` Relations ========= .. _modelet_models_concept: -**modelet_models_concept** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```phenomenon`` `__\ ``)`` +**modelet_models_concept** ( `modelet `_ > `phenomenon `_ ) -------------------------------------------------------------------------------------------------------------- -The `phenomenon `__ symbolizing the *phenomenon* of a -`modelet `__. !!! question “TODO” rename from ‘concept’ to -something else. ###### Source: ``engines-and-modelets.tff`` +The `phenomenon `_ symbolizing the *phenomenon* of a `modelet `_. + +Source: ``engines-and-modelets.tff`` .. _formalism_of_modelet: -**formalism_of_modelet** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```formalism`` `__\ ``)`` +**formalism_of_modelet** ( `modelet `_ > `formalism `_ ) ---------------------------------------------------------------------------------------------------------- -The `formalism `__ used by a `modelet <#modelet>`__ to -describe the *phenomenon*. ###### Source: ``engines-and-modelets.tff`` +The `formalism `_ used by a `modelet `_ to describe the *phenomenon*. + +Source: ``engines-and-modelets.tff`` .. _modelet_creation_date: -**modelet_creation_date** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ **``$real``**\ ``)`` +**modelet_creation_date** ( `modelet `_ > **$real** ) ---------------------------------------------------------------------------------------- -The date a `modelet <#modelet>`__ was created. !!! question “TODO” The -date is represented as a ``$real`` but we don’t make any assumptions -about what that number represents. Unix time? time since last restart? -seconds? This may be solved by integration with ``spacetime_point``. -###### Source: ``engines-and-modelets.tff`` +The date a `modelet `_ was created. + +.. admonition:: TODO + + The date is represented as a ``$real`` but we don’t make any assumptions about what that number represents. Unix time? time since last restart? seconds? This may be solved by integration with ``spacetime_point``. + +Source: ``engines-and-modelets.tff`` .. _modelet_has_location: -**modelet_has_location** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```spacetime_point`` `__\ ``)`` +**modelet_has_location** ( `modelet `_ > `spacetime_point `_ ) ---------------------------------------------------------------------------------------------------------------------- -The time and spatial location a `modelet <#modelet>`__ refers to. -`Modelets `__ may have a specific temporal scope or make an -observation at a specific ```spacetime_point`` `__. -###### Source: ``engines-and-modelets.tff`` +The time and spatial location a `modelet `_ refers to. `Modelets `_ may have a specific temporal scope or make an observation at a specific `spacetime_point `_. + +Source: ``engines-and-modelets.tff`` .. _modelet_has_extent: -**modelet_has_extent** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```extent`` `__\ ``)`` +**modelet_has_extent** ( `modelet `_ > `extent `_ ) -------------------------------------------------------------------------------------------------- -The time and spatial `extent `__ a `modelet <#modelet>`__ -refers to. `Modelets <#modelet>`__ may have an area/volume/duration of -reference. ###### Source: ``engines-and-modelets.tff`` +The time and spatial `extent `_ a `modelet `_ refers to. `Modelets `_ may have an area/volume/duration of reference. + +Source: ``engines-and-modelets.tff`` .. _modelet_has_representation_class: -**modelet_has_representation_class** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```representation_class`` `__\ ``)`` +**modelet_has_representation_class** ( `modelet `_ > `representation_class `_ ) -------------------------------------------------------------------------------------------------------------------------------------------- -The `representation_class `__ a -`modelet <#modelet>`__\ ’s relation to its parents has after being -created by an `engine `__. !!! question “TODO” This looks -like it will turn out to be HOL. ###### Source: -``engines-and-modelets.tff`` +The `representation_class `_ a `modelet `_’s relation to its parents has after being created by an `engine `_. + +.. hint:: + + This looks like it will turn out to be HOL. + +Source: ``engines-and-modelets.tff`` .. _modelet_has_creator: -**modelet_has_creator** ``(``\ ```modelet`` <#modelet>`__\ ``>``\ ```engine`` `__\ ``)`` +**modelet_has_creator** ( `modelet `_ > `engine `_ ) --------------------------------------------------------------------------------------------------- -The `engine `__ that created the `modelet <#modelet>`__. -###### Source: ``engines-and-modelets.tff`` +The `engine `_ that created the `modelet `_. + +Source: ``engines-and-modelets.tff`` .. _is_in_modelet_set: -**is_in_modelet_set** ``((``\ ```modelet`` <#modelet>`__\ ``*``\ ```modelet_set`` <#modelet_set>`__\ ``) >``\ **``$o``**\ ``)`` +**is_in_modelet_set** (( `modelet `_ * `modelet_set `_ ) > **$o** ) ------------------------------------------------------------------------------------------------------------------------------- -Check if a `modelet <#modelet>`__ is a member of a -`modelet_set <#modelet_set>`__. ###### Source: -``engines-and-modelets.tff`` +Check if a `modelet `_ is a member of a `modelet_set `_. + +Source: ``engines-and-modelets.tff`` diff --git a/understanding-logic/concepts/origin.rst b/understanding-logic/concepts/origin.rst index 5f78220..6fc8be1 100644 --- a/understanding-logic/concepts/origin.rst +++ b/understanding-logic/concepts/origin.rst @@ -6,16 +6,13 @@ Types **origin** ``$tType`` --------------------- -An agent’s perspective on the *phenomenon* captured in a particular -`modelet `__. +An agent’s perspective on the *phenomenon* captured in a particular `modelet `_. - Observation is *situated* in time and space -- Measured with sensors that have certain characteristics and - limitations +- Measured with sensors that have certain characteristics and limitations - (inferred) physical quality (e.g. distance inferred from delay) - resolution and frame rate - reflections and transparencies could be misinterpreted Source: Understanding presentation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/understanding-logic/concepts/phenomenon.rst b/understanding-logic/concepts/phenomenon.rst index 561b4a3..07391a9 100644 --- a/understanding-logic/concepts/phenomenon.rst +++ b/understanding-logic/concepts/phenomenon.rst @@ -6,12 +6,17 @@ Types **phenomenon** ``$tType`` ------------------------- -Some space or object or being or process in the real world that the -system represents using `modelets `__. +Some space or object or being or process in the real world that the system represents using `modelets `_. - *Situated* in time and space - May change over time - Associated with a mission-dependent *meaning* -!!! example - you - your office - your tea - your tea approaching room -temperature ###### Source: ``fundamental-concepts.tff`` +.. admonition:: Example + + - you + - your office + - your tea + - your tea approaching room temperature + +Source: ``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/property.rst b/understanding-logic/concepts/property.rst index f780f9b..4b94f62 100644 --- a/understanding-logic/concepts/property.rst +++ b/understanding-logic/concepts/property.rst @@ -1,49 +1,55 @@ Types ===== -.. _property: + **property** ``$tType`` ----------------------- -A specific characteristic of a `modelet `__ or -`engine `__. Multiple things can exhibit the same -`property <#property>`__. +A specific characteristic of a `modelet `_ or `engine `_. Multiple things can exhibit the same `property `_. + +.. admonition:: example -!!! example - color: red - age: 14 years ###### Source: -``properties.tff`` + - color: red + - age: 14 years + +Source: ``properties.tff`` Relations ========= .. _has_value: -**has_value** ``(``\ ```property`` <#property>`__\ ``>``\ **``$real``**\ ``)`` +**has_value** ( `property <#property>`_ > **$real** ) ------------------------------------------------------------------------------ -The value of a certain `property <#property>`__. ###### Source: -``properties.tff`` +The value of a certain `property <#property>`_. + +Source: ``properties.tff`` .. _datatype_of_p: -**datatype_of_property** ``(``\ ```property`` <#property>`__\ ``>``\ ```datatype`` `__\ ``)`` ----------------------------------------------------------------------------------------------------------- +**datatype_of_property** ( `property <#property>`_ > `datatype `_ ) +----------------------------------------------------------------------------------------------------------- -The `datatype `__ of a certain `property <#property>`__. -###### Source: ``properties.tff`` +The `datatype `_ of a certain `property <#property>`_. + +Source: ``properties.tff`` .. _is_property_of_m: -**is_property_of_modelet** ``((``\ ```property`` <#property>`__\ ``*``\ ```modelet`` `__\ ``) >``\ **``$o``**\ ``)`` --------------------------------------------------------------------------------------------------------------------------------- +**is_property_of_modelet** (( `property <#property>`_ * `modelet `_ ) > **$o** ) +--------------------------------------------------------------------------------------------------------------------------------- + +Check if a `modelet `_ is described by a certain `property <#property>`_. -Check if a `modelet `__ is described by a certain -`property <#property>`__. ###### Source: ``properties.tff`` +Source: ``properties.tff`` .. _is_property_of_e: -**is_property_of_engine** ``((``\ ```property`` <#property>`__\ ``*``\ ```engine`` `__\ ``) >``\ **``$o``**\ ``)`` ------------------------------------------------------------------------------------------------------------------------------ +**is_property_of_engine** (( `property <#property>`_ * `engine `_ ) > **$o** ) +------------------------------------------------------------------------------------------------------------------------------ + +Check if an `engine `_ is described by a certain `property <#property>`_. -Check if an `engine `__ is described by a certain -`property <#property>`__. ###### Source: ``properties.tff`` +Source: ``properties.tff`` diff --git a/understanding-logic/concepts/representation_class.rst b/understanding-logic/concepts/representation_class.rst index d307ed7..19dabc4 100644 --- a/understanding-logic/concepts/representation_class.rst +++ b/understanding-logic/concepts/representation_class.rst @@ -6,6 +6,6 @@ Types **representation_class** ``$tType`` ----------------------------------- -The purpose of a `modelet `__ (extrinsic to itself) when -used by an `engine `__. Class in the *Processing/Modelling -Model*. ###### Source: ``fundamental-concepts.tff`` +The relation a `modelet `_ has with its parents, i.e. the inputs to the `engine `_ `exertion `_. Class of their relation in the *Processing/Modelling Model*. + +Source: ``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/requirement.rst b/understanding-logic/concepts/requirement.rst index d382163..d187479 100644 --- a/understanding-logic/concepts/requirement.rst +++ b/understanding-logic/concepts/requirement.rst @@ -1,36 +1,41 @@ Types ===== -.. _requirement: + **requirement** ``$tType`` -------------------------- -A restriction on the `property `__ values that a -`template `__ may enforce on a `modelet `__. -###### Source: ``properties.tff`` +A restriction on the `property `_ values that a `template `_ may enforce on a `modelet `_. + +Source: ``properties.tff`` Relations ========= .. _datatype_of_p: -**datatype_of_requirement** ``(``\ ```requirement`` <#requirement>`__\ ``>``\ ```datatype`` `__\ ``)`` -------------------------------------------------------------------------------------------------------------------- +**datatype_of_requirement** ( `requirement <#requirement>`_ > `datatype `_ ) +-------------------------------------------------------------------------------------------------------------------- + +The `datatype `_ of a certain `requirement <#requirement>`_. -The `datatype `__ of a certain -`requirement <#requirement>`__. ###### Source: ``properties.tff`` +Source: ``properties.tff`` .. _is_permissible: -**is_permissible** ``((``\ ```requirement`` <#requirement>`__\ ``*``\ **``$real``**\ ``) >``\ **``$o``**\ ``)`` +**is_permissible** (( `requirement <#requirement>`_ * **$real** ) > **$o** ) --------------------------------------------------------------------------------------------------------------- -Check if a value is *permissible* under a certain -`requirement <#requirement>`__. ###### Source: ``properties.tff`` +Check if a value is *permissible* under a certain `requirement <#requirement>`_. + +Source: ``properties.tff`` + +.. _is_part_of: + +**is_part_of** (( `requirement <#requirement>`_ * `template `_ ) > **$o** ) +------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -**is_part_of** ``((``\ ```requirement`` <#requirement>`__\ ``*``\ ```template`` `__\ ``) >``\ **``$o``**\ ``)`` { $is_part_of data-toc-label=‘is_part_of’ } ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +Check if a `requirement <#requirement>`_ is part of a `template `_. -Check if a `requirement <#requirement>`__ is part of a -`template `__. ###### Source: ``properties.tff`` +Source: ``properties.tff`` diff --git a/understanding-logic/concepts/spacetime_point.rst b/understanding-logic/concepts/spacetime_point.rst index dcc76d0..0a2cb0b 100644 --- a/understanding-logic/concepts/spacetime_point.rst +++ b/understanding-logic/concepts/spacetime_point.rst @@ -1,50 +1,53 @@ Types ===== -.. _spacetime_point: + **spacetime_point** ``$tType`` ------------------------------ -4-dimensional coordinates (3 space, 1 time). !!! note Not to be confused -with a 4-dimentional ```extent`` `__. ###### Source: -``fundamental-concepts.tff`` +4-dimensional coordinates (3 space, 1 time). + +.. note:: + Not to be confused with a 4-dimentional `extent `_. + +Source: ``fundamental-concepts.tff`` Relations ========= .. _point_x: -**point_x** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +**point_x** ( `spacetime_point <#spacetime_point>`_ > **$real** ) ------------------------------------------------------------------------------------------ -The spatial ``x`` coordinate of a point in space and time -(```spacetime_point`` <#spacetime_point>`__). ###### Source: -``fundamental-concepts.tff`` +The spatial ``x`` coordinate of a point in space and time (`spacetime_point <#spacetime_point>`_). + +Source: ``fundamental-concepts.tff`` .. _point_y: -**point_y** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +**point_y** ( `spacetime_point <#spacetime_point>`_ > **$real** ) ------------------------------------------------------------------------------------------ -The spatial ``y`` coordinate of a point in space and time -(```spacetime_point`` <#spacetime_point>`__). ###### Source: -``fundamental-concepts.tff`` +The spatial ``y`` coordinate of a point in space and time (`spacetime_point <#spacetime_point>`_). + +Source: ``fundamental-concepts.tff`` .. _point_z: -**point_z** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +**point_z** ( `spacetime_point <#spacetime_point>`_ > **$real** ) ------------------------------------------------------------------------------------------ -The spatial ``z`` coordinate of a point in space and time -(```spacetime_point`` <#spacetime_point>`__). ###### Source: -``fundamental-concepts.tff`` +The spatial ``z`` coordinate of a point in space and time (`spacetime_point <#spacetime_point>`_). + +Source: ``fundamental-concepts.tff`` .. _point_t: -**point_t** ``(``\ ```spacetime_point`` <#spacetime_point>`__\ ``>``\ **``$real``**\ ``)`` +**point_t** ( `spacetime_point <#spacetime_point>`_ > **$real** ) ------------------------------------------------------------------------------------------ -The time ``t`` coordinate of a point in space and time -(```spacetime_point`` <#spacetime_point>`__). ###### Source: -``fundamental-concepts.tff`` +The time ``t`` coordinate of a point in space and time (`spacetime_point <#spacetime_point>`_). + +Source: ``fundamental-concepts.tff`` diff --git a/understanding-logic/concepts/strategy.rst b/understanding-logic/concepts/strategy.rst index 8208c6d..092f0ea 100644 --- a/understanding-logic/concepts/strategy.rst +++ b/understanding-logic/concepts/strategy.rst @@ -3,18 +3,13 @@ Types .. _strategy: -**strategy** ``((``\ ```modelet_set`` `__\ ``*``\ `modelet `__\ ``) >``\ **``$o``**\ ``)`` --------------------------------------------------------------------------------------------------------------------------------------- +**strategy** (( `modelet_set `_ * `modelet `_ ) > **$o** ) +---------------------------------------------------------------------------------------------------------------------------------------- -A succession of `exertions `__ of `engines `__ -connects `modelets `__. `Strategies <#strategy>`__ -are transitive. - -- Must respect engine `requirements `__ -- Matches `modelet `__ *phenomenon* semantics to physical - reality +A succession of `exertions `_ of `engines `_ connects `modelets `_. `Strategies `_ are transitive. +- Must respect engine `requirements `_ +- Matches `modelet `_ *phenomenon* semantics to physical reality - e.g. “on the living room table” to coordinates Source: ``transitive-strategies.tff`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/understanding-logic/concepts/template.rst b/understanding-logic/concepts/template.rst index 5c7d2b8..f8bb7a1 100644 --- a/understanding-logic/concepts/template.rst +++ b/understanding-logic/concepts/template.rst @@ -1,81 +1,85 @@ Types ===== -.. _template: + **template** ``$tType`` ----------------------- -Describes the features that a single `modelet `__ should -have for an `engine `__ to accept it as input. +Describes the features that a single `modelet `_ should have for an `engine `_ to accept it as input. - a semantic function signature -- `properties `__ and `requirements `__ of - `modelets `__ ###### Source: ``engines-and-modelets.tff`` +- `properties `_ and `requirements `_ of `modelets `_ + +Source: ``engines-and-modelets.tff`` -.. _template_set: **template_set** ``$tType`` --------------------------- -Some particular set of `templates <#template>`__ which describe the -inputs to an `engine `__. !!! example - {t1, t2, t3} - {t2} - -{} ###### Source: ``engines-and-modelets.tff`` +Some particular set of `templates `_ which describe the inputs to an `engine `_. + +.. admonition:: Example + + - {t1, t2, t3} + - {t2} + - {} + +Source: ``engines-and-modelets.tff`` Relations ========= .. _template_has_concept_requirement: -**template_has_concept_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```concept`` `__\ ``)`` --------------------------------------------------------------------------------------------------------------------- +**template_has_concept_requirement** ( `template <#template>`_ > `concept `_ ) +--------------------------------------------------------------------------------------------------------------------- + +The `concept `_ symbolizing the *phenomenon class* of a `template `_. -The `concept `__ symbolizing the *phenomenon class* of a -`template `__. ###### Source: ``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` .. _template_formalism_requirement: -**template_formalism_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```formalism`` `__\ ``)`` ----------------------------------------------------------------------------------------------------------------------- +**template_formalism_requirement** ( `template <#template>`_ > `formalism `_ ) +----------------------------------------------------------------------------------------------------------------------- + +The `formalism `_ this `template <#template>`_ expects the *phenomenon* to be described by. -The `formalism `__ this `template <#template>`__ expects -the *phenomenon* to be described by. ###### Source: -``engines-and-templates.tff`` +Source: ``engines-and-templates.tff`` .. _template_has_location_requirement: -**template_has_location_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```spacetime_point`` `__\ ``)`` -------------------------------------------------------------------------------------------------------------------------------------- +**template_has_location_requirement** ( `template <#template>`_ > `spacetime_point `_ ) +-------------------------------------------------------------------------------------------------------------------------------------- -The time and spatial location a `template <#template>`__ refers to. A -`template `__ may have a specific temporal scope or expect -an observation at a specific -```spacetime_point`` `__. ###### Source: -``engines-and-modelets.tff`` +The time and spatial location a `template <#template>`_ refers to. A `template `_ may have a specific temporal scope or expect an observation at a specific `spacetime_point `_. + +Source: ``engines-and-modelets.tff`` .. _template_has_extent_requirement: -**template_has_extent_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```extent`` `__\ ``)`` ------------------------------------------------------------------------------------------------------------------ +**template_has_extent_requirement** ( `template <#template>`_ > `extent `_ ) +------------------------------------------------------------------------------------------------------------------ + +The time and spatial `extent `_ a `template <#template>`_ covers. A `template <#template>`_ may expect an area/volume/duration of reference. -The time and spatial `extent `__ a `template <#template>`__ -covers. A `template <#template>`__ may expect an area/volume/duration of -reference. ###### Source: ``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` .. _template_has_creator_requirement: -**template_has_creator_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```engine`` `__\ ``)`` ------------------------------------------------------------------------------------------------------------------- +**template_has_creator_requirement** ( `template <#template>`_ > `engine `_ ) +------------------------------------------------------------------------------------------------------------------- + +The `engine `_ a `template <#template>`_ requires a `modelet `_ to have been created by. -The `engine `__ a `template <#template>`__ requires a -`modelet `__ to have been created by. ###### Source: -``engines-and-modelets.tff`` +Source: ``engines-and-modelets.tff`` .. _is_in_template_set: -**is_in_template_set** ``((``\ ```template`` <#template>`__\ ``*``\ ```template_set`` <#template_set>`__\ ``) >``\ **``$o``**\ ``)`` +**is_in_template_set** (( `template <#template>`_ * `template_set <#template_set>`_ ) > **$o** ) ------------------------------------------------------------------------------------------------------------------------------------ -Check if a `template <#template>`__ is a member of a -`template_set <#template_set>`__. ###### Source: -``engines-and-modelets.tff`` +Check if a `template <#template>`_ is a member of a `template_set <#template_set>`_. + +Source: ``engines-and-modelets.tff`` diff --git a/understanding-logic/index.rst b/understanding-logic/index.rst index 6542de7..ab3f49c 100644 --- a/understanding-logic/index.rst +++ b/understanding-logic/index.rst @@ -1 +1,13 @@ -–8<– “README.rst” +.. _understanding-logic: + +Understanding Logic +################### + +This work is hosted at `CoreSenseEU/understanding-logic `_. + +.. toctree:: + :maxdepth: 1 + + concepts/index.rst + packages/index.rst + usage/index.rst