+ {% block sidebar2 %} {# possible location for sidebar #} {% endblock %}
+
+
+{%- endblock %}
diff --git a/doc/conf.py.in b/doc/conf.py.in
index ba02a60ae..b30a0df1e 100644
--- a/doc/conf.py.in
+++ b/doc/conf.py.in
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
'''
-Copyright (c) 2015 vrpRouting developers
+Copyright (c) 2025 vrpRouting developers
Mail: project@pgrouting.org
------
@@ -23,18 +23,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# vrpRouting Documentation documentation build configuration file, created by
-# sphinx-quickstart on Sat Mar 23 16:03:51 2013.
-#
-# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
+
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
import sys, os
-@SPHINX_INCLUDE@
+import sphinx_bootstrap_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -43,275 +39,131 @@ import sys, os
# -- General configuration -----------------------------------------------------
-# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '3.4.3'
+needs_sphinx = '4.0.0'
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-#mathjax_path="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
extensions = [
'sphinx.ext.todo',
'sphinx.ext.mathjax',
'sphinx.ext.graphviz',
+ 'sphinx.ext.autosectionlabel',
]
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
+# -- Extensions configuration -----------------------------------------------------
+autosectionlabel_prefix_document = True
+graphviz_dot='neato'
-# General information about the project.
project = u'vrpRouting'
-copyright = u'vrpRouting Contributors - Version @PROJECT_FULL_VERSION@'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '@PROJECT_FULL_VERSION@'
-# The full version, including alpha/beta/rc tags.
+copyright = u'vrpRouting Contributors - Version @PROJECT_LIB_VERSION@'
+version = '@PROJECT_LIB_VERSION@'
release = '@PROJECT_FULL_VERSION@'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
language = 'en'
-locale_dirs = ['@CMAKE_SOURCE_DIR@/locale/']
-#gettext_compact = False
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = [
- 'doc/build',
- ]
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+master_doc = 'index'
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
+templates_path = ["_templates"]
+locale_dirs = ['@CMAKE_SOURCE_DIR@/locale/']
+source_suffix = {
+ '.rst': 'restructuredtext',
+ }
+exclude_patterns = [ ]
add_module_names = False
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = '@SPHINX_THEME@'
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-html_theme_options = {
- @SPHINX_THEME_OPTIONS@
- }
+# -- Options for internationalization ---------------------------------------------------
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = @SPHINX_THEME_DIR@
+gettext_allow_fuzzy_translations = False
+gettext_location = True
+gettext_uuid = False
+gettext_auto_build = True
+#For example: gettext_additional_targets = ['literal-block','raw','index','doctest-block']
+gettext_additional_targets = []
-# The name for this set of Sphinx documents. If None, it defaults to
-# " v documentation".
-html_title = "vrpRouting Manual (@PROJECT_SHORT_VERSION@)"
+# -- Options for HTML output ---------------------------------------------------
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
html_logo = "_static/images/vrprouting.png"
+html_theme = 'bootstrap'
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+html_theme_options = {
+ 'navbar_class': "navbar",
+ 'source_link_position': "nav",
+ 'bootstrap_version': "2",
+ 'navbar_sidebarrel': True,
+ 'navbar_pagenav': True,
+ 'navbar_pagenav_name': "Page",
+ 'globaltoc_includehidden': True,
+ 'globaltoc_depth': 2,
+ 'navbar_fixed_top': "true",
+ 'navbar_links': [
+ ("pgvroom", "https://vrp.pgrouting.org", True),
+ ],
+ }
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
+html_title = "vrpRouting Manual (@PROJECT_SHORT_VERSION@)"
html_favicon = "_static/images/favicon.ico"
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
def setup(app):
app.add_css_file('custom.css')
+ app.add_js_file('page_history.js')
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-html_sidebars = {
- # '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],
- # 'using/windows': ['windowssidebar.html', 'searchbox.html'],
-}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
html_domain_indices = False
-
-# If false, no index is generated.
html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False
-# Don't copy sources
html_copy_source = False
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'vrpRoutingDocumentation'
-
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-'papersize': 'a4paper',
-
-# The font size ('10pt', '11pt' or '12pt').
-'pointsize': '10pt',
+ 'papersize': 'a4paper',
+ 'pointsize': '10pt',
+ }
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'vrpRoutingDocumentation.tex', u'vrpRouting Manual',
u'vrpRouting Contributors', 'manual'),
]
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
latex_logo = "_static/images/vrprouting.png"
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
latex_show_urls = 'footnote'
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
latex_domain_indices = False
# -- Options for manual page output --------------------------------------------
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
man_pages = [
('index_man', 'vrprouting', u'vrpRouting Reference', u'vrpRouting Contributors', 7)
]
-
-# If true, show URL addresses after external links.
man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
texinfo_documents = [
('index', 'vrprouting', u'vrpRouting Manual',
u'vrpRouting Contributors', 'vrpRoutingDocumentation', 'One line description of project.',
'Miscellaneous'),
]
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
# -- Options for PDF output --------------------------------------------------
-# Grouping the document tree into PDF files. List of tuples
-# (source start file, target name, title, author, options).
-#
-# If there is more than one author, separate them with \\.
-# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
-#
-# The options element is a dictionary that lets you override
-# this config per-document.
-# For example,
-# ('index', u'MyProject', u'My Project', u'Author Name',
-# dict(pdf_compressed = True))
-# would mean that specific document would be compressed
-# regardless of the global pdf_compressed setting.
+
pdf_documents = [(
'index',
u'vrp_Documentation',
'vrpRouting Manual',
u'vrpRouting Contributors')]
-# A comma-separated list of custom stylesheets. Example:
pdf_stylesheets = ['sphinx','kerning','a4']
-# A list of folders to search for stylesheets. Example:
pdf_style_path = ['.', '_styles']
-# Linkcheck configuration, see https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
-
-# cases to ignore during link checking
+# -- Options for linkcheck output --------------------------------------------------
linkcheck_ignore = [
# might not exist yet (we are generating it!)
r"https://gis.stackexchange.com/",
@@ -320,11 +172,11 @@ linkcheck_ignore = [
"https://www.leopark.mx",
# (see: https://github.com/sphinx-doc/sphinx/issues/7388)
- r"https://github.com/pgRouting/vrprouting/", # limit only vrprouting
+ r"https://github.com/pgRouting/vrprouting/",
]
linkcheck_timeout = 20
-linkcheck_retries = 5
+linkcheck_retries = 2
linkcheck_anchors = False
rst_epilog="""
@@ -334,4 +186,5 @@ rst_epilog="""
.. |br| raw:: html
+.. |epilog_end| replace:: just a marker for notes2news
"""
diff --git a/doc/general/CMakeLists.txt b/doc/general/CMakeLists.txt
index 3be8e26e2..9ed1b552b 100644
--- a/doc/general/CMakeLists.txt
+++ b/doc/general/CMakeLists.txt
@@ -1,23 +1,18 @@
SET(LOCAL_FILES
- concepts.rst
- experimental.rst
- index.rst
- introduction.rst
- official.rst
- installation.rst
- proposed.rst
- release_notes.rst
- sampledata.rst
- support.rst
- pgr-category.rst
- vroom-category.rst
- or_tools-category.rst
- )
+ concepts.rst
+ index.rst
+ introduction.rst
+ functions.rst
+ installation.rst
+ release_notes.rst
+ sampledata.rst
+ support.rst
+)
foreach (f ${LOCAL_FILES})
- configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
- list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
+ configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
+ list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
endforeach()
set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
diff --git a/doc/general/concepts.rst b/doc/general/concepts.rst
index 68a186895..8b2810825 100644
--- a/doc/general/concepts.rst
+++ b/doc/general/concepts.rst
@@ -9,11 +9,6 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
Concepts
===============================================================================
@@ -543,474 +538,6 @@ A ``SELECT`` statement that returns the following columns:
.. pgr_vehicles_e_end
-Vroom Inner Queries
-...............................................................................
-
-Vroom, because of the data types used internally, some maximum values apply.
-
-For ``TIMESTAMP``:
-
-.. literalinclude:: concepts.queries
- :start-after: q1
- :end-before: q2
-
-For ``INTERVAL``:
-
-.. literalinclude:: concepts.queries
- :start-after: q2
- :end-before: q3
-
-
-Jobs SQL
-*******************************************************************************
-
-.. jobs_start
-
-A ``SELECT`` statement that returns the following columns:
-
-| ``id, location_id``
-| ``[setup, service, delivery, pickup, skills, priority, data]``
-
-Maximum values apply from vroom
-
-``setup`` and ``service``
-
-- |intervalmax|
-
-``skills``
-
-- :math:`2147483647`
-
-``priority``
-
-- :math:`100`
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- - - Column
- - Type
- - Default
- - Description
- - - ``id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the job.
- - - ``location_id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the location of the job.
- - - ``setup``
- - |interval|
- - |interval0|
- - The Job setup duration.
-
- - - ``service``
- - |interval|
- - |interval0|
- - The Job service duration. Max value:
- - - ``pickup``
- - ``ARRAY[ANY-INTEGER]``
- - ``[]``
- - Array of non-negative integers describing multidimensional quantities for
- pickup such as number of items, weight, volume etc.
-
- - All jobs must have the same value of :code:`array_length(pickup, 1)`
- - - ``delivery``
- - ``ARRAY[ANY-INTEGER]``
- - ``[]``
- - Array of non-negative integers describing multidimensional quantities for
- delivery such as number of items, weight, volume etc.
-
- - All jobs must have the same value of :code:`array_length(delivery, 1)`
- - - ``skills``
- - ``ARRAY[ANY-INTEGER]``
- - ``[]``
- - Array of non-negative integers defining mandatory skills.
- - - ``priority``
- - ``INTEGER``
- - :math:`0`
- - Value range: :math:`[0, 100]`
- - - ``data``
- - ``JSONB``
- - ``'{}'::JSONB``
- - Any metadata information of the job.
-
-.. jobs_end
-
-Shipments SQL
-*******************************************************************************
-
-.. shipments_start
-
-A ``SELECT`` statement that returns the following columns:
-
-| ``id``
-| ``p_location_id, [p_setup, p_service, p_data]``
-| ``d_location_id, [d_setup, d_service, d_data]``
-| ``[amount, skills, priority]``
-
-Maximum values apply from vroom
-
-``p_setup``, ``p_service``, ``d_setup``, ``d_service``
-
-- |intervalmax|
-
-``skills``
-
-- :math:`2147483647`
-
-``priority``
-
-- :math:`100`
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- - - Column
- - Type
- - Default
- - Description
- - - ``id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the shipment.
- - - ``p_location_id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the pickup location.
- - - ``p_setup``
- - |interval|
- - |interval0|
- - The pickup setup duration
- - - ``p_service``
- - |interval|
- - |interval0|
- - The pickup service duration
- - - ``p_data``
- - ``JSONB``
- - ``'{}'::JSONB``
- - Any metadata information of the pickup.
- - - ``d_location_id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the pickup location.
- - - ``d_setup``
- - |interval|
- - |interval0|
- - The pickup setup duration
- - - ``d_service``
- - |interval|
- - |interval0|
- - The pickup service duration
- - - ``d_data``
- - ``JSONB``
- - ``'{}'::JSONB``
- - Any metadata information of the delivery.
- - - ``amount``
- - ``ARRAY[ANY-INTEGER]``
- - ``[]``
- - Array of non-negative integers describing multidimensional quantities
- such as number of items, weight, volume etc.
-
- - All shipments must have the same value of :code:`array_length(amount,
- 1)`
-
- - - ``skills``
- - ``ARRAY[ANY-INTEGER]``
- - ``[]``
- - Array of non-negative integers defining mandatory skills.
-
- - :math:`values \leq 2147483647`
- - - ``priority``
- - ``INTEGER``
- - :math:`0`
- - Value range: :math:`[0, 100]`
-
-.. shipments_end
-
-Vehicles SQL
-*******************************************************************************
-
-.. vroom_vehicles_start
-
-A ``SELECT`` statement that returns the following columns:
-
-| ``id, start_id, end_id``
-| ``[capacity, skills, tw_open, tw_close, speed_factor, max_tasks, data]``
-
-Maximum values apply from vroom
-
-``skills``
-
-- :math:`2147483647`
-
-``priority``
-
-- :math:`100`
-
-.. list-table::
- :width: 81
- :widths: 14,20,10,37
- :header-rows: 1
-
- - - Column
- - Type
- - Default
- - Description
- - - ``id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the vehicle.
- - - ``start_id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the start location.
- - - ``end_id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the end location.
- - - ``capacity``
- - ``ARRAY[ANY-INTEGER]``
- - ``[]``
- - Array of non-negative integers describing multidimensional quantities
- such as number of items, weight, volume etc.
-
- - All vehicles must have the same value of :code:`array_length(capacity,
- 1)`
- - - ``skills``
- - ``ARRAY[ANY-INTEGER]``
- - ``[]``
- - Array of non-negative integers defining mandatory skills.
- - - ``tw_open``
- - |timestamp|
- - |tw_open_default|
- - Time window opening time.
-
- - :code:`tw_open \leq tw_close`
- - - ``tw_close``
- - |timestamp|
- - |tw_close_default|
- - Time window closing time.
-
- - :code:`tw_open \leq tw_close`
- - - ``speed_factor``
- - |ANY-NUMERICAL|
- - :math:`1.0`
- - Vehicle travel time multiplier.
-
- - Max value of speed factor for a vehicle shall not be greater than 5
- times the speed factor of any other vehicle.
- - - ``max_tasks``
- - ``INTEGER``
- - :math:`2147483647`
- - Maximum number of tasks in a route for the vehicle.
-
- - A job, pickup, or delivery is counted as a single task.
- - - ``data``
- - ``JSONB``
- - ``'{}'::JSONB``
- - Any metadata information of the vehicle.
-
-**Note**:
-
-- At least one of the ``start_id`` or ``end_id`` shall be present.
-- If ``end_id`` is omitted, the resulting route will stop at the last visited
- task, whose choice is determined by the optimization process.
-- If ``start_id`` is omitted, the resulting route will start at the first
- visited task, whose choice is determined by the optimization process.
-- To request a round trip, specify both ``start_id`` and ``end_id`` as the same
- index.
-- A vehicle is only allowed to serve a set of tasks if the resulting load at
- each route step is lower than the matching value in capacity for each metric.
- When using multiple components for amounts, it is recommended to put the most
- important/limiting metrics first.
-- It is assumed that all delivery-related amounts for jobs are loaded at vehicle
- start, while all pickup-related amounts for jobs are brought back at vehicle
- end.
-
-.. vroom_vehicles_end
-
-Vroom Matrix SQL
-*******************************************************************************
-
-.. vroom_matrix_start
-
-A ``SELECT`` statement that returns the following columns:
-
-| ``start_id, end_id, duration``
-| ``[ cost]``
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- - - Column
- - Type
- - Default
- - Description
- - - ``start_id``
- - |ANY-INTEGER|
- -
- - Identifier of the start node.
- - - ``end_id``
- - |ANY-INTEGER|
- -
- - Identifier of the end node.
- - - ``duration``
- - |interval|
- -
- - Time to travel from ``start_id`` to ``end_id``
- - - ``cost``
- - |interval|
- - ``duration``
- - Cost of travel from ``start_id`` to ``end_id``
-
-.. vroom_matrix_end
-
-Breaks SQL
-*******************************************************************************
-
-.. breaks_start
-
-A ``SELECT`` statement that returns the following columns:
-
-| ``id, vehicle_id``
-| ``[service, data]``
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- - - Column
- - Type
- - Default
- - Description
- - - ``id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the break. Unique for the same vehicle.
- - - ``vehicle_id``
- - |ANY-INTEGER|
- -
- - Positive unique identifier of the vehicle.
- - - ``service``
- - |interval|
- - |interval0|
- - The break duration
- - - ``data``
- - ``JSONB``
- - ``'{}'::JSONB``
- - Any metadata information of the break.
-
-.. breaks_end
-
-
-Time Windows SQL
-*******************************************************************************
-
-.. rubric:: Shipment Time Windows SQL
-
-.. shipments_time_windows_start
-
-A ``SELECT`` statement that returns the following columns:
-
-| ``id, tw_open, tw_close``
-| ``[kind]``
-
-.. list-table::
- :width: 81
- :widths: 14 14 44
- :header-rows: 1
-
- - - Column
- - Type
- - Description
- - - ``id``
- - |ANY-INTEGER|
- - Positive unique identifier of the: job, pickup/delivery shipment, or
- break.
- - - ``tw_open``
- - |timestamp|
- - Time window opening time.
- - - ``tw_close``
- - |timestamp|
- - Time window closing time.
- - - ``kind``
- - ``CHAR``
- - Value in ['p', 'd'] indicating whether the time window is for:
-
- - Pickup shipment, or
- - Delivery shipment.
-
-.. shipments_time_windows_end
-
-.. rubric:: General Time Windows SQL
-
-.. general_time_windows_start
-
-A ``SELECT`` statement that returns the following columns:
-
-``id, tw_open, tw_close``
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- - - Column
- - Type
- - Description
- - - ``id``
- - |ANY-INTEGER|
- - Positive unique identifier of the: job, pickup/delivery shipment, or
- break.
- - - ``tw_open``
- - |timestamp|
- - Time window opening time.
- - - ``tw_close``
- - |timestamp|
- - Time window closing time.
-
-.. general_time_windows_end
-
-.. time_windows_note_start
-
-**Note**:
-
-- All timings are in **seconds** when represented as an ``INTEGER``.
-- Every row must satisfy the condition: :code:`tw_open ≤ tw_close`.
-- Time windows can be interpreted by the users:
-
- - **Relative values**, e.g.
-
- - Let the beginning of the planning horizon :math:`0`.
- - for a 4 hour time window (:math:`4 * 3600 = 14400` seconds) starting from
- the planning horizon
-
- - ``tw_open`` = :math:`0`
- - ``tw_close`` = :math:`14400`
-
- - Times reported in output relative to the start of the planning horizon.
-
- - **Absolute values**,
-
- - Let the beginning of the planning horizon ``2019-07-30 08:00:00``
- - for a 4 hour time window starting from the planning horizon
-
- - ``tw_open`` = ``2019-07-30 08:00:00``
- - ``tw_close`` = ``2019-07-30 12:00:00``
-
- - Times reported in output can be interpreted as ``TIMESTAMP``.
-
-.. time_windows_note_end
-
Return columns & values
--------------------------------------------------------------------------------
@@ -1157,139 +684,283 @@ Returns set of
.. pde_result_end
-VROOM result columns
+.. rubric:: Adding Functionaity to vrpRouting
+
+Consult the `developer's documentation `_
+
+Parameters
...............................................................................
-.. vroom_result_start
-Returns set of
+Pick & deliver
+*******************************************************************************
+
+Both implementations use the following same parameters:
+
+.. pd_parameters_start
+
+================= ================== ========= =================================================
+Column Type Default Description
+================= ================== ========= =================================================
+**orders_sql** ``TEXT`` `Pick & Deliver Orders SQL`_ query containing the orders to be processed.
+**vehicles_sql** ``TEXT`` `Pick & Deliver Vehicles SQL`_ query containing the vehicles to be used.
+**factor** ``NUMERIC`` 1 (Optional) Travel time multiplier. See :ref:`pd_factor`
+**max_cycles** ``INTEGER`` 10 (Optional) Maximum number of cycles to perform on the optimization.
+**initial_sol** ``INTEGER`` 4 (Optional) Initial solution to be used.
+
+ - ``1`` One order per truck
+ - ``2`` Push front order.
+ - ``3`` Push back order.
+ - ``4`` Optimize insert.
+ - ``5`` Push back order that allows more orders to be inserted at the back
+ - ``6`` Push front order that allows more orders to be inserted at the front
+================= ================== ========= =================================================
+
+.. pd_parameters_end
+
+The non euclidean implementation, additionally has:
+
+================= ================== =================================================
+Column Type Description
+================= ================== =================================================
+**matrix_sql** ``TEXT`` `Pick & Deliver Matrix SQL`_ query containing the distance or travel times.
+================= ================== =================================================
+
+
+Inner Queries 1
+*******************************************************************************
+
+- `Pick & Deliver Orders SQL`_
+- `Pick & Deliver Vehicles SQL`_
+- `Pick & Deliver Matrix SQL`_
+
+
+Pick & Deliver Orders SQL
+*******************************************************************************
+
+In general, the columns for the orders SQL is the same in both implementation of pick and delivery:
+
+.. pd_orders_sql_general_start
+
+================ =================== =========== ================================================
+Column Type Default Description
+================ =================== =========== ================================================
+**id** |ANY-INTEGER| Identifier of the pick-delivery order pair.
+**demand** |ANY-NUMERICAL| Number of units in the order
+**p_open** |ANY-NUMERICAL| The time, relative to 0, when the pickup location opens.
+**p_close** |ANY-NUMERICAL| The time, relative to 0, when the pickup location closes.
+**d_service** |ANY-NUMERICAL| 0 The duration of the loading at the pickup location.
+**d_open** |ANY-NUMERICAL| The time, relative to 0, when the delivery location opens.
+**d_close** |ANY-NUMERICAL| The time, relative to 0, when the delivery location closes.
+**d_service** |ANY-NUMERICAL| 0 The duration of the loading at the delivery location.
+================ =================== =========== ================================================
+
+
+.. pd_orders_sql_general_end
+
+
+.. pd_orders_sql_matrix_start
+
+For the non euclidean implementation, the starting and ending identifiers are needed:
+
+================== =================== ================================================
+Column Type Description
+================== =================== ================================================
+**p_node_id** |ANY-INTEGER| The node identifier of the pickup, must match a node identifier in the matrix table.
+**d_node_id** |ANY-INTEGER| The node identifier of the delivery, must match a node identifier in the matrix table.
+================== =================== ================================================
+
+.. pd_orders_sql_matrix_end
+
+
+.. pd_orders_euclidean_sql_start
+
+For the euclidean implementation, pick up and delivery :math:`(x,y)` locations are needed:
+
+================ =================== ================================================
+Column Type Description
+================ =================== ================================================
+**p_x** |ANY-NUMERICAL| :math:`x` value of the pick up location
+**p_y** |ANY-NUMERICAL| :math:`y` value of the pick up location
+**d_x** |ANY-NUMERICAL| :math:`x` value of the delivery location
+**d_y** |ANY-NUMERICAL| :math:`y` value of the delivery location
+================ =================== ================================================
+
+
+.. pd_orders_euclidean_sql_end
+
+
+
+
+Pick & Deliver Vehicles SQL
+*******************************************************************************
+
+In general, the columns for the vehicles_sql is the same in both implementation of pick and delivery:
+
+.. pd_vehicle_sql_general_start
+
+================== =================== ================ ================================================
+Column Type Default Description
+================== =================== ================ ================================================
+**id** |ANY-INTEGER| Identifier of the pick-delivery order pair.
+**capacity** |ANY-NUMERICAL| Number of units in the order
+**speed** |ANY-NUMERICAL| `1` Average speed of the vehicle.
+
+**start_open** |ANY-NUMERICAL| The time, relative to 0, when the starting location opens.
+**start_close** |ANY-NUMERICAL| The time, relative to 0, when the starting location closes.
+**start_service** |ANY-NUMERICAL| `0` The duration of the loading at the starting location.
+
+**end_open** |ANY-NUMERICAL| `start_open` The time, relative to 0, when the ending location opens.
+**end_close** |ANY-NUMERICAL| `start_close` The time, relative to 0, when the ending location closes.
+**end_service** |ANY-NUMERICAL| `start_service` The duration of the loading at the ending location.
+================== =================== ================ ================================================
+
+.. pd_vehicle_sql_general_end
+
+.. pd_vehicle_sql_matrix_start
+
+For the non euclidean implementation, the starting and ending identifiers are needed:
+
+================== =================== ================ ================================================
+Column Type Default Description
+================== =================== ================ ================================================
+**start_node_id** |ANY-INTEGER| The node identifier of the starting location, must match a node identifier in the matrix table.
+**end_node_id** |ANY-INTEGER| `start_node_id` The node identifier of the ending location, must match a node identifier in the matrix table.
+================== =================== ================ ================================================
+
+.. pd_vehicle_sql_matrix_end
+
+.. pd_vehicle_sql_euclidean_start
+
+For the euclidean implementation, starting and ending :math:`(x,y)` locations are needed:
+
+================== =================== ================ ================================================
+Column Type Default Description
+================== =================== ================ ================================================
+**start_x** |ANY-NUMERICAL| :math:`x` value of the coordinate of the starting location.
+**start_y** |ANY-NUMERICAL| :math:`y` value of the coordinate of the starting location.
+**end_x** |ANY-NUMERICAL| `start_x` :math:`x` value of the coordinate of the ending location.
+**end_y** |ANY-NUMERICAL| `start_y` :math:`y` value of the coordinate of the ending location.
+================== =================== ================ ================================================
+
+.. pd_vehicle_sql_euclidean_end
+
+
+Pick & Deliver Matrix SQL
+*******************************************************************************
+
+.. TODO
+
+.. warning:: TODO
+
+
+
+
+Results
+*******************************************************************************
+
+..
+ OUT seq INTEGER,
+ OUT vehicle_seq INTEGER,
+ OUT vehicle_id BIGINT,
+ OUT stop_seq INTEGER,
+ OUT order_id BIGINT,
+ OUT stop_type INT,
+ OUT cargo FLOAT,
+ OUT travel_time FLOAT,
+ OUT arrival_time FLOAT,
+ OUT wait_time FLOAT,
+ OUT service_time FLOAT,
+ OUT departure_time FLOAT
+
+.. _return_vrp_matrix_start:
+
+Description of the result (TODO Disussion: Euclidean & Matrix)
+*******************************************************************************
+
+.. todo:: fix when everything below is fixed
+
.. code-block:: none
- (seq, vehicle_seq, vehicle_id, vehicle_data, step_seq, step_type, task_id,
- task_data, arrival, travel_time, service_time, waiting_time, load)
+ RETURNS SET OF
+ (seq, vehicle_seq, vehicle_id, stop_seq, stop_type,
+ travel_time, arrival_time, wait_time, service_time, departure_time)
+ UNION
+ (summary row)
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
+=================== ============= =================================================
+Column Type Description
+=================== ============= =================================================
+**seq** INTEGER Sequential value starting from **1**.
+**vehicle_seq** INTEGER Sequential value starting from **1** for current vehicles. The :math:`n_{th}` vehicle in the solution.
+**vehicle_id** BIGINT Current vehicle identifier.
+**stop_seq** INTEGER Sequential value starting from **1** for the stops made by the current vehicle. The :math:`m_{th}` stop of the current vehicle.
+**stop_type** INTEGER Kind of stop location the vehicle is at:
- - - Column
- - Type
- - Description
- - - ``seq``
- - ``BIGINT``
- - Sequential value starting from **1**.
- - - ``vehicle_seq``
- - ``BIGINT``
- - Sequential value starting from **1** for current vehicles. The
- :math:`n^{th}` vehicle in the solution.
- - - ``vehicle_id``
- - ``BIGINT``
- - Current vehicle identifier.
+ - ``1``: Starting location
+ - ``2``: Pickup location
+ - ``3``: Delivery location
+ - ``6``: Ending location
- - ``-1``: Vehicle denoting all the unallocated tasks.
- - ``0``: Summary row for the complete problem
- - - ``vehicle_data``
- - ``JSONB``
- - Metadata information of the vehicle.
- - - ``step_seq``
- - ``BIGINT``
- - Sequential value starting from **1** for the stops made by the current
- vehicle. The :math:`m^{th}` stop of the current vehicle.
+**order_id** BIGINT Pickup-Delivery order pair identifier.
- - ``0``: Summary row
- - - ``step_type``
- - ``BIGINT``
- - Kind of the step location the vehicle is at:
+ - ``-1``: When no order is involved on the current stop location.
- - ``0``: Summary row
- - ``1``: Starting location
- - ``2``: Job location
- - ``3``: Pickup location
- - ``4``: Delivery location
- - ``5``: Break location
- - ``6``: Ending location
+**cargo** FLOAT Cargo units of the vehicle when leaving the stop.
- - - ``task_id``
- - ``BIGINT``
- - Identifier of the task performed at this step.
+**travel_time** FLOAT Travel time from previous ``stop_seq`` to current ``stop_seq``.
- - ``0``: Summary row
- - ``-1``: If the step is starting/ending location.
- - - ``location_id``
- - ``BIGINT``
- - Identifier of the task location.
-
- - ``0``: Summary row
- - - ``task_data``
- - ``JSONB``
- - Metadata information of the task.
- - - ``arrival``
- - |timestamp|
- - Estimated time of arrival at this step.
- - - ``travel_time``
- - |interval|
- - Travel time from previous ``step_seq`` to current ``step_seq``.
-
- - ``0``: When ``step_type = 1``
- - - ``setup_time``
- - |interval|
- - Setup time at this step.
- - - ``service_time``
- - |interval|
- - Service time at this step.
- - - ``waiting_time``
- - |interval|
- - Waiting time at this step.
- - - ``departure``
- - |timestamp|
- - Estimated time of departure at this step.
-
- - :math:`arrival + service\_time + waiting\_time`.
- - - ``load``
- - ``BIGINT``
- - Vehicle load after step completion (with capacity constraints)
+ - ``0`` When ``stop_type = 1``
-**Note**:
+**arrival_time** FLOAT Previous ``departure_time`` plus current ``travel_time``.
+**wait_time** FLOAT Time spent waiting for current `location` to open.
+**service_time** FLOAT Service time at current `location`.
+**departure_time** FLOAT :math:`arrival\_time + wait\_time + service\_time`.
-- Unallocated tasks are mentioned at the end with :code:`vehicle_id = -1`.
-- The last step of every vehicle denotes the summary row, where the columns
- ``travel_time``, ``service_time`` and ``waiting_time`` denote the total time
- for the corresponding vehicle,
-- The last row denotes the summary for the complete problem, where the columns
- ``travel_time``, ``service_time`` and ``waiting_time`` denote the total time
- for the complete problem,
+ - When ``stop_type = 6`` has the `total_time` used for the current vehicle.
+=================== ============= =================================================
-.. vroom_result_end
+.. rubric:: Summary Row
+.. warning:: TODO: Review the summary
-Performance
--------------------------------------------------------------------------------
+=================== ============= =================================================
+Column Type Description
+=================== ============= =================================================
+**seq** INTEGER Continues the Sequential value
+**vehicle_seq** INTEGER ``-2`` to indicate is a summary row
+**vehicle_id** BIGINT `Total Capacity Violations` in the solution.
+**stop_seq** INTEGER `Total Time Window Violations` in the solution.
+**stop_type** INTEGER ``-1``
+**order_id** BIGINT ``-1``
+**cargo** FLOAT ``-1``
+**travel_time** FLOAT `total_travel_time` The sum of all the `travel_time`
+**arrival_time** FLOAT ``-1``
+**wait_time** FLOAT `total_waiting_time` The sum of all the `wait_time`
+**service_time** FLOAT `total_service_time` The sum of all the `service_time`
+**departure_time** FLOAT `total_solution_time` = :math:`total\_travel\_time + total\_wait\_time + total\_service\_time`.
+=================== ============= =================================================
-TBD
-How to contribute
--------------------------------------------------------------------------------
+.. return_vrp_matrix_end
-.. rubric:: Wiki
-* Edit an existing `vrpRouting Wiki `_ page.
-.. rubric:: Adding Functionaity to vrpRouting
-Consult the `developer's documentation `_
+.. rubric:: See Also
+
+* https://en.wikipedia.org/wiki/Vehicle_routing_problem
+* The queries use the :doc:`sampledata` network.
.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`search`
-.. |interval| replace:: :abbr:`ANY-INTERVAL(INTERVAL, SMALLINT, INTEGER, BIGINT)`
-.. |interval0| replace:: :abbr:`INTERVAL 0('make_interval(secs => 0), 0)`
-.. |intervalmax| replace:: **INTERVAL**: ``make_interval(secs => 4294967295)`` and |br| |ANY-INTEGER|: :math:`4294967295`
-.. |timestamp| replace:: :abbr:`ANY-TIMESTAMP(TIMESTAMP, SMALLINT, INTEGER, BIGINT)`
-.. |tw_open_default| replace:: :abbr:`TW-OPEN-DEFAULT(to_timestamp(0), 0)`
-.. |tw_close_default| replace:: :abbr:`TW-CLOSE-DEFAULT(to_timestamp(4294967295), 4294967295)`
+.. rubric:: Indices and tables
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/doc/general/experimental.rst b/doc/general/experimental.rst
deleted file mode 100644
index b1070840c..000000000
--- a/doc/general/experimental.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-Experimental Functions
-===============================================================================
-
-.. begin-warn-expr
-
-.. warning:: Possible server crash
-
- - These functions might create a server crash
-
-.. warning:: Experimental functions
-
- - They are not officially of the current release.
- - They likely will not be officially be part of the next release:
-
- - The functions might not make use of ANY-INTEGER and ANY-NUMERICAL
- - Name might change.
- - Signature might change.
- - Functionality might change.
- - pgTap tests might be missing.
- - Might need c/c++ coding.
- - May lack documentation.
- - Documentation if any might need to be rewritten.
- - Documentation examples might need to be automatically generated.
- - Might need a lot of feedback from the comunity.
- - Might depend on a proposed function of vrpRouting
- - Might depend on a deprecated function of vrpRouting
-
-.. end-warn-expr
-
-.. rubric:: categories
-
-:doc:`pgr-category`
-
-
-.. toctree::
- :maxdepth: 2
-
- pgr-category
- vroom-category
- or_tools-category
-
-.. rubric:: See Also
-
-* :doc:`proposed`
-* :doc:`official`
-
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
diff --git a/doc/general/official.rst b/doc/general/functions.rst
similarity index 54%
rename from doc/general/official.rst
rename to doc/general/functions.rst
index 06921e42d..3327468a5 100644
--- a/doc/general/official.rst
+++ b/doc/general/functions.rst
@@ -9,39 +9,51 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`0 `__)
-Oficial functions
-*******************************************************************************
-
-Function Families
+Functions
===============================================================================
+.. functions_start
-
-Version
+Utilities
-------------------------------------------------------------------------------
-.. toctree::
- :maxdepth: 1
-
- vrp_version
- vrp_full_version
+- :doc:`vrp_version`
+- :doc:`vrp_full_version`
+VRP functions
+===============================================================================
+- vrp_compatiblevehicles
+- vrp_compatiblevehiclesraw
+- :doc:`vrp_oneDepot`
+- vrp_optimize
+- vrp_optimizeraw
+- vrp_optimizeupdateraw
+- :doc:`vrp_pgr_pickDeliver`
+- :doc:`vrp_pgr_pickDeliverEuclidean`
+- vrp_pickdeliver
+- vrp_pickdeliveradd
+- vrp_pickdeliveraddraw
+- vrp_pickdeliverraw
+- vrp_simulation
+- vrp_viewroute
+- vrp_viewrouteraw
+
+.. functions_end
-Functions by categories
-===============================================================================
+.. toctree::
+ :hidden:
-Version
--------------------------------------------------------------------------------
+ vrp_version
+ vrp_full_version
-* :doc:`vrp_version` - Get vrpRouting's version information.
-* :doc:`vrp_full_version` - Get vrpRouting's details of version.
+.. toctree::
+ :hidden:
+ vrp_oneDepot
+ vrp_pgr_pickDeliver
+ vrp_pgr_pickDeliverEuclidean
.. rubric:: Indices and tables
diff --git a/doc/general/index.rst b/doc/general/index.rst
index 31b707f58..f514508c8 100644
--- a/doc/general/index.rst
+++ b/doc/general/index.rst
@@ -9,10 +9,6 @@
|
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
.. _index:
*******************************************************************************
@@ -52,59 +48,30 @@ General
sampledata
-Pgrouting Concepts
+:doc:`functions`
===============================================================================
-.. toctree::
- :maxdepth: 2
-
- concepts
-
-
-.. rubric:: Reference
-
-* :doc:`vrp_version` - Get vrpRouting's version information.
-* :doc:`vrp_full_version` - Get vrpRouting's details of version.
+.. include:: functions.rst
+ :start-after: functions_start
+ :end-before: functions_end
.. toctree::
:hidden:
- vrp_version
- vrp_full_version
-
-
-Official functions
-===============================================================================
-
-.. toctree::
- :maxdepth: 3
-
- official
+ functions
-
-
-
-Available functions but not official vrpRouting functions
+:doc:`release_notes`
===============================================================================
-.. toctree::
- :maxdepth: 3
-
- proposed
- experimental
-
-
-
-Release Notes
-===============================================================================
+.. include:: release_notes.rst
+ :start-after: current
.. toctree::
+ :hidden:
- release_notes
-
+ release_notes
.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`search`
-
diff --git a/doc/general/introduction.rst b/doc/general/introduction.rst
index 6c2e1600c..30074d0ce 100644
--- a/doc/general/introduction.rst
+++ b/doc/general/introduction.rst
@@ -9,11 +9,6 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
Introduction
===============================================================================
@@ -21,29 +16,42 @@ vrpRouting is a `PostgreSQL `__ extension that exten
of `pgRouting `__ extension, by adding solutions to several
Vehicle Routing Problems.
-The project is supported and manatianed by `Georepublic `__,
-`Paragon Corporation `__ and a broad user community.
+The project is supported and maintained by
+
+- `Paragon Corporation `__
+- `erosion `__
-vrpRouting is a subproduct of `pgRouting `__ organization which is an
-`OSGeo Community Project `__.
+and a broad user community.
+vrpRouting is a sub product of `pgRouting organization `__
+organization.
.. _license:
-Licensing
+License
-------------------------------------------------------------------------------
The following licenses can be found in vrpRouting:
-* GNU General Public License 2 or latar, `GPL-2.0-or-later `__.
+.. list-table::
+ :widths: 250 500
- * For code in any language.
+ * - **License**
+ -
+ * - GNU General Public License v2.0 or later
+ - Most features of pgvroom are available under GNU General Public License
+ v2.0 or later `GPL-2.0-or-later
+ `__.
+ * - BSD 2-Clause "Simplified" License
+ - VROOM is under `BSD 2-Clause "Simplified" License
+ `__
+ * - Creative Commons Attribution-Share Alike 3.0 License
+ - The pgvroom Manual and examples is licensed under a `Creative Commons
+ Attribution-Share Alike 3.0 License
+ `_.
-* Creative Commons Attribution-Share Alike 3.0 License `CC BY-SA 3.0 `__.
- * For user's & developer's documentation
-
-In general license information should be included in the header of each source file.
+In general license information is included in the header of each source file.
Contributors
@@ -57,11 +65,7 @@ Individuals (in alphabetical order)
- Ashish Kumar
- - Adding new experimental VROOM category functions: vrp_vroom, vrp_vroomJobs, vrp_vroomShipments.
-
-- Manas Sivakumar
-
- - Adding Google Or tools functionality to vrprouting
+ - Handling the CI
- Joseph Percival
@@ -78,34 +82,30 @@ And all the people that give us a little of their time making comments, finding
Corporate Sponsors (in alphabetical order)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-These are corporate entities that have contributed developer time, hosting, or direct monetary funding to the vrpRouting project:
+These are corporate entities that have contributed developer time, hosting, or
+direct monetary funding to the pgvroom project:
+- `Erosion developers `__
- `Paragon Corporation `__
Contributors Past & Present:
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-Individuals (in alphabetical order)
+Individuals past & present (in alphabetical order)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. Add your name, optionally you can add your email, one name each line, examples:
- name
- `name `__
-
-`Ashish Kumar `__
-`Daniel Kastl `__
-`Joseph Percival `__
-`Vicky Vergara `__
-`Manas Sivakumar `__
+- Ashish Kumar
+- Vicky Vergara
+- Joseph Percival
+- Regina Robe
-Corporate Sponsors (in alphabetical order)
+Corporate Sponsors past & present (in alphabetical order)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These are corporate entities that have contributed developer time, hosting, or
direct monetary funding to the vrpRouting project:
-- Georepublic
-- Leopark
+- Erosion developers
- Paragon Corporation
diff --git a/doc/general/or_tools-category.rst b/doc/general/or_tools-category.rst
deleted file mode 100644
index b6ca2ed17..000000000
--- a/doc/general/or_tools-category.rst
+++ /dev/null
@@ -1,135 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-OR-Tools - Category (Experimental)
-===============================================================================
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-
-.. contents::
-
-.. rubric:: Functions
-
-.. toctree::
- :maxdepth: 1
-
- vrp_knapsack
- vrp_multiple_knapsack
- vrp_bin_packing
-
-
-Synopsis
--------------------------------------------------------------------------------
-
-OR-Tools is an open source software suite for optimization, tuned for tackling
-the world's toughest problems in vehicle routing, flows, integer and linear
-programming, and constraint programming.
-
-OR-Tools can solve
-
-- VR (Vehicle Routing)
-- Scheduling
-- Bin Packing
-
-Currently only Bin Packing problems can be solved with OR-Tools in vrpRouting.
-
-Terminologies
-...............................................................................
-
-- **weight**: For each item, a positive integer weight is associated with it.
-- **cost**: For each item, a positive integer cost(value) is associated with it.
-- **capacity**: Maximum storage capacity of a knapsack or a bin.
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Weight Costs SQL
-...............................................................................
-
-A ``SELECT`` statement that returns the following columns:
-
-.. weight_costs_start
-
-.. list-table::
- :width: 81
- :widths: 14 14 44
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - ``id``
- - **ANY-INTEGER**
- - Unique identifier of the item.
- * - ``weight``
- - **ANY-INTEGER**
- - Weight of the item.
- * - ``cost``
- - **ANY-INTEGER**
- - Cost of the item.
-
-Where:
-
-:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
-
-.. weight_costs_end
-
-Weights SQL
-...............................................................................
-
-.. weights_start
-
-A ``SELECT`` statement that returns the following columns:
-
-.. list-table::
- :width: 81
- :widths: 14 14 44
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - ``id``
- - **ANY-INTEGER**
- - Identifier of the item.
- * - ``weight``
- - **ANY-INTEGER**
- - Weight of the item.
-
-Where:
-
-:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
-
-.. weights_end
-
-See Also
--------------------------------------------------------------------------------
-
-.. see_also_start
-
-* `Wikipedia: Bin Packing problems `__
-* `OR-Tools: Google OR-Tools `__
-
-.. see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
diff --git a/doc/general/pgr-category.rst b/doc/general/pgr-category.rst
deleted file mode 100644
index 2c20c6f41..000000000
--- a/doc/general/pgr-category.rst
+++ /dev/null
@@ -1,311 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-Vehicle Routing Functions - Category (Experimental)
-===============================================================================
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-
-.. contents::
-
-.. rubric:: Functions
-
-.. toctree::
- :maxdepth: 1
-
- vrp_pgr_pickDeliver
- vrp_pgr_pickDeliverEuclidean
- vrp_oneDepot
-
-
-
-
-Parameters
-...............................................................................
-
-
-Pick & deliver
-*******************************************************************************
-
-Both implementations use the following same parameters:
-
-.. pd_parameters_start
-
-================= ================== ========= =================================================
-Column Type Default Description
-================= ================== ========= =================================================
-**orders_sql** ``TEXT`` `Pick & Deliver Orders SQL`_ query containing the orders to be processed.
-**vehicles_sql** ``TEXT`` `Pick & Deliver Vehicles SQL`_ query containing the vehicles to be used.
-**factor** ``NUMERIC`` 1 (Optional) Travel time multiplier. See :ref:`pd_factor`
-**max_cycles** ``INTEGER`` 10 (Optional) Maximum number of cycles to perform on the optimization.
-**initial_sol** ``INTEGER`` 4 (Optional) Initial solution to be used.
-
- - ``1`` One order per truck
- - ``2`` Push front order.
- - ``3`` Push back order.
- - ``4`` Optimize insert.
- - ``5`` Push back order that allows more orders to be inserted at the back
- - ``6`` Push front order that allows more orders to be inserted at the front
-================= ================== ========= =================================================
-
-.. pd_parameters_end
-
-The non euclidean implementation, additionally has:
-
-================= ================== =================================================
-Column Type Description
-================= ================== =================================================
-**matrix_sql** ``TEXT`` `Pick & Deliver Matrix SQL`_ query containing the distance or travel times.
-================= ================== =================================================
-
-
-Inner Queries
-*******************************************************************************
-
-- `Pick & Deliver Orders SQL`_
-- `Pick & Deliver Vehicles SQL`_
-- `Pick & Deliver Matrix SQL`_
-
-
-Pick & Deliver Orders SQL
-*******************************************************************************
-
-In general, the columns for the orders SQL is the same in both implementation of pick and delivery:
-
-.. pd_orders_sql_general_start
-
-================ =================== =========== ================================================
-Column Type Default Description
-================ =================== =========== ================================================
-**id** |ANY-INTEGER| Identifier of the pick-delivery order pair.
-**demand** |ANY-NUMERICAL| Number of units in the order
-**p_open** |ANY-NUMERICAL| The time, relative to 0, when the pickup location opens.
-**p_close** |ANY-NUMERICAL| The time, relative to 0, when the pickup location closes.
-**d_service** |ANY-NUMERICAL| 0 The duration of the loading at the pickup location.
-**d_open** |ANY-NUMERICAL| The time, relative to 0, when the delivery location opens.
-**d_close** |ANY-NUMERICAL| The time, relative to 0, when the delivery location closes.
-**d_service** |ANY-NUMERICAL| 0 The duration of the loading at the delivery location.
-================ =================== =========== ================================================
-
-
-.. pd_orders_sql_general_end
-
-
-.. pd_orders_sql_matrix_start
-
-For the non euclidean implementation, the starting and ending identifiers are needed:
-
-================== =================== ================================================
-Column Type Description
-================== =================== ================================================
-**p_node_id** |ANY-INTEGER| The node identifier of the pickup, must match a node identifier in the matrix table.
-**d_node_id** |ANY-INTEGER| The node identifier of the delivery, must match a node identifier in the matrix table.
-================== =================== ================================================
-
-.. pd_orders_sql_matrix_end
-
-
-.. pd_orders_euclidean_sql_start
-
-For the euclidean implementation, pick up and delivery :math:`(x,y)` locations are needed:
-
-================ =================== ================================================
-Column Type Description
-================ =================== ================================================
-**p_x** |ANY-NUMERICAL| :math:`x` value of the pick up location
-**p_y** |ANY-NUMERICAL| :math:`y` value of the pick up location
-**d_x** |ANY-NUMERICAL| :math:`x` value of the delivery location
-**d_y** |ANY-NUMERICAL| :math:`y` value of the delivery location
-================ =================== ================================================
-
-
-.. pd_orders_euclidean_sql_end
-
-
-
-
-Pick & Deliver Vehicles SQL
-*******************************************************************************
-
-In general, the columns for the vehicles_sql is the same in both implementation of pick and delivery:
-
-.. pd_vehicle_sql_general_start
-
-================== =================== ================ ================================================
-Column Type Default Description
-================== =================== ================ ================================================
-**id** |ANY-INTEGER| Identifier of the pick-delivery order pair.
-**capacity** |ANY-NUMERICAL| Number of units in the order
-**speed** |ANY-NUMERICAL| `1` Average speed of the vehicle.
-
-**start_open** |ANY-NUMERICAL| The time, relative to 0, when the starting location opens.
-**start_close** |ANY-NUMERICAL| The time, relative to 0, when the starting location closes.
-**start_service** |ANY-NUMERICAL| `0` The duration of the loading at the starting location.
-
-**end_open** |ANY-NUMERICAL| `start_open` The time, relative to 0, when the ending location opens.
-**end_close** |ANY-NUMERICAL| `start_close` The time, relative to 0, when the ending location closes.
-**end_service** |ANY-NUMERICAL| `start_service` The duration of the loading at the ending location.
-================== =================== ================ ================================================
-
-.. pd_vehicle_sql_general_end
-
-.. pd_vehicle_sql_matrix_start
-
-For the non euclidean implementation, the starting and ending identifiers are needed:
-
-================== =================== ================ ================================================
-Column Type Default Description
-================== =================== ================ ================================================
-**start_node_id** |ANY-INTEGER| The node identifier of the starting location, must match a node identifier in the matrix table.
-**end_node_id** |ANY-INTEGER| `start_node_id` The node identifier of the ending location, must match a node identifier in the matrix table.
-================== =================== ================ ================================================
-
-.. pd_vehicle_sql_matrix_end
-
-.. pd_vehicle_sql_euclidean_start
-
-For the euclidean implementation, starting and ending :math:`(x,y)` locations are needed:
-
-================== =================== ================ ================================================
-Column Type Default Description
-================== =================== ================ ================================================
-**start_x** |ANY-NUMERICAL| :math:`x` value of the coordinate of the starting location.
-**start_y** |ANY-NUMERICAL| :math:`y` value of the coordinate of the starting location.
-**end_x** |ANY-NUMERICAL| `start_x` :math:`x` value of the coordinate of the ending location.
-**end_y** |ANY-NUMERICAL| `start_y` :math:`y` value of the coordinate of the ending location.
-================== =================== ================ ================================================
-
-.. pd_vehicle_sql_euclidean_end
-
-
-Pick & Deliver Matrix SQL
-*******************************************************************************
-
-.. TODO
-
-.. warning:: TODO
-
-
-
-
-Results
-*******************************************************************************
-
-..
- OUT seq INTEGER,
- OUT vehicle_seq INTEGER,
- OUT vehicle_id BIGINT,
- OUT stop_seq INTEGER,
- OUT order_id BIGINT,
- OUT stop_type INT,
- OUT cargo FLOAT,
- OUT travel_time FLOAT,
- OUT arrival_time FLOAT,
- OUT wait_time FLOAT,
- OUT service_time FLOAT,
- OUT departure_time FLOAT
-
-.. _return_vrp_matrix_start:
-
-Description of the result (TODO Disussion: Euclidean & Matrix)
-*******************************************************************************
-
-.. todo:: fix when everything below is fixed
-
-
-.. code-block:: none
-
- RETURNS SET OF
- (seq, vehicle_seq, vehicle_id, stop_seq, stop_type,
- travel_time, arrival_time, wait_time, service_time, departure_time)
- UNION
- (summary row)
-
-=================== ============= =================================================
-Column Type Description
-=================== ============= =================================================
-**seq** INTEGER Sequential value starting from **1**.
-**vehicle_seq** INTEGER Sequential value starting from **1** for current vehicles. The :math:`n_{th}` vehicle in the solution.
-**vehicle_id** BIGINT Current vehicle identifier.
-**stop_seq** INTEGER Sequential value starting from **1** for the stops made by the current vehicle. The :math:`m_{th}` stop of the current vehicle.
-**stop_type** INTEGER Kind of stop location the vehicle is at:
-
- - ``1``: Starting location
- - ``2``: Pickup location
- - ``3``: Delivery location
- - ``6``: Ending location
-
-**order_id** BIGINT Pickup-Delivery order pair identifier.
-
- - ``-1``: When no order is involved on the current stop location.
-
-**cargo** FLOAT Cargo units of the vehicle when leaving the stop.
-
-**travel_time** FLOAT Travel time from previous ``stop_seq`` to current ``stop_seq``.
-
- - ``0`` When ``stop_type = 1``
-
-**arrival_time** FLOAT Previous ``departure_time`` plus current ``travel_time``.
-**wait_time** FLOAT Time spent waiting for current `location` to open.
-**service_time** FLOAT Service time at current `location`.
-**departure_time** FLOAT :math:`arrival\_time + wait\_time + service\_time`.
-
- - When ``stop_type = 6`` has the `total_time` used for the current vehicle.
-=================== ============= =================================================
-
-.. rubric:: Summary Row
-
-.. warning:: TODO: Review the summary
-
-=================== ============= =================================================
-Column Type Description
-=================== ============= =================================================
-**seq** INTEGER Continues the Sequential value
-**vehicle_seq** INTEGER ``-2`` to indicate is a summary row
-**vehicle_id** BIGINT `Total Capacity Violations` in the solution.
-**stop_seq** INTEGER `Total Time Window Violations` in the solution.
-**stop_type** INTEGER ``-1``
-**order_id** BIGINT ``-1``
-**cargo** FLOAT ``-1``
-**travel_time** FLOAT `total_travel_time` The sum of all the `travel_time`
-**arrival_time** FLOAT ``-1``
-**wait_time** FLOAT `total_waiting_time` The sum of all the `wait_time`
-**service_time** FLOAT `total_service_time` The sum of all the `service_time`
-**departure_time** FLOAT `total_solution_time` = :math:`total\_travel\_time + total\_wait\_time + total\_service\_time`.
-=================== ============= =================================================
-
-
-.. return_vrp_matrix_end
-
-
-
-
-
-
-.. rubric:: See Also
-
-* https://en.wikipedia.org/wiki/Vehicle_routing_problem
-* The queries use the :doc:`sampledata` network.
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
diff --git a/doc/general/proposed.rst b/doc/general/proposed.rst
deleted file mode 100644
index cbe744a86..000000000
--- a/doc/general/proposed.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-Proposed Functions
-==================================
-
-.. stable-begin-warning
-
-.. warning:: Proposed functions for next mayor release.
-
- - They are not officially in the current release.
- - They will likely officially be part of the next mayor release:
-
- - The functions make use of ANY-INTEGER and ANY-NUMERICAL
- - Name might not change. (But still can)
- - Signature might not change. (But still can)
- - Functionality might not change. (But still can)
- - pgTap tests have being done. But might need more.
- - Documentation might need refinement.
-
-.. stable-end-warning
-
-.. rubric:: Families
-
-
-.. rubric:: See Also
-
-* :doc:`experimental`
-* :doc:`official`
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
diff --git a/doc/general/release_notes.rst b/doc/general/release_notes.rst
index 9fbcd304a..bdaba5277 100644
--- a/doc/general/release_notes.rst
+++ b/doc/general/release_notes.rst
@@ -9,11 +9,6 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
Release Notes
===============================================================================
@@ -31,15 +26,45 @@ vrpRouting 0
:local:
:depth: 1
+vrpRouting 0.5
+-------------------------------------------------------------------------------
+
+.. contents:: Contents
+ :local:
+ :depth: 1
+
+vrpRouting 0.5.0 Release Notes
+...............................................................................
+
+To see all issues & pull requests closed by this release see the
+`Git closed milestone for 0.5.0 `_
+on Github.
+
+.. rubric:: Removing vroom
+
+- vrp_vroomjobsplain(text,text,text,text,text,text,integer,integer)
+- vrp_vroomjobs(text,text,text,text,text,text,integer,interval)
+- vrp_vroomplain(text,text,text,text,text,text,text,text,integer,integer)
+- vrp_vroomshipmentsplain(text,text,text,text,text,text,integer,integer)
+- vrp_vroomshipments(text,text,text,text,text,text,integer,interval)
+- _vrp_vroom(text,text,text,text,text,text,text,text,integer,integer,smallint,boolean)
+- vrp_vroom(text,text,text,text,text,text,text,text,integer,interval)
+
+.. rubric:: Removing or-tools
+
+- vrp_bin_packing(text,integer,integer)
+- vrp_knapsack(text,integer,integer)
+- vrp_multiple_knapsack(text,integer[],integer)
+
vrpRouting 0.4
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+-------------------------------------------------------------------------------
.. contents:: Contents
:local:
:depth: 1
vrpRouting 0.4.2 Release Notes
--------------------------------------------------------------------------------
+...............................................................................
To see all issues & pull requests closed by this release see the
`Git closed milestone for 0.4.2 `_
@@ -59,7 +84,7 @@ on Github.
* Removed `doc-` and `doc-vrp_` suffixes on file names
vrpRouting 0.4.1 Release Notes
--------------------------------------------------------------------------------
+...............................................................................
To see all issues & pull requests closed by this release see the
`Git closed milestone for 0.4.1 `_
@@ -74,16 +99,8 @@ on Github.
* vrp_knapsack
* vrp_multiple_knapsack
- .. include:: vrp_bin_packing.rst
- :start-after: Version 0.4.1
- :end-before: Version
-
* vrp_oneDepot
- .. include:: vrp_oneDepot.rst
- :start-after: Version 0.4.1
- :end-before: Version
-
.. rubric:: Removal of Boost on the build
* vrp_full_version
@@ -94,7 +111,7 @@ on Github.
:end-before: Version
vrpRouting 0.4.0 Release Notes
--------------------------------------------------------------------------------
+...............................................................................
To see all issues & pull requests closed by this release see the
`Git closed milestone for 0.4.0 `_
@@ -110,7 +127,14 @@ on Github.
- Removed support for VROOM 1.11.0
vrpRouting 0.3
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+-------------------------------------------------------------------------------
+
+.. contents:: Contents
+ :local:
+ :depth: 1
+
+vrpRouting 0.3.0 Release Notes
+...............................................................................
To see all issues & pull requests closed by this release see the
`Git closed milestone for 0.3.0 `_
@@ -152,7 +176,14 @@ on Github.
- Added departure field and location_id field in the result columns.
vrpRouting 0.2
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+-------------------------------------------------------------------------------
+
+.. contents:: Contents
+ :local:
+ :depth: 1
+
+vrpRouting 0.2.0 Release Notes
+...............................................................................
.. rubric:: New experimental functions
@@ -175,7 +206,14 @@ vrpRouting 0.2
- vrp_viewRoute
vrpRouting 0.1
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+-------------------------------------------------------------------------------
+
+.. contents:: Contents
+ :local:
+ :depth: 1
+
+vrpRouting 0.1.0 Release Notes
+...............................................................................
.. rubric:: Extraction tasks
diff --git a/doc/general/sampledata.rst b/doc/general/sampledata.rst
index f19b52b0c..4fc67beac 100644
--- a/doc/general/sampledata.rst
+++ b/doc/general/sampledata.rst
@@ -31,13 +31,6 @@ City Network
:end-before: --EDGE TABLE ADD DATA end
-.. rubric:: Update geometry
-
-.. literalinclude:: ../../tools/testers/sampledata.sql
- :start-after: --EDGE TABLE update geometry start
- :end-before: --EDGE TABLE update geometry end
-
-
.. rubric:: Add Topology
.. literalinclude:: ../../tools/testers/sampledata.sql
@@ -57,96 +50,12 @@ Vehicles table
Orders table
...............................................................................
-
.. literalinclude:: ../../tools/testers/sampledata.sql
:start-after: --ORDERS TABLE start
:end-before: --ORDERS TABLE end
+
`vrp_oneDepot` data
-------------------------------------------------------------------------------
.. literalinclude:: ../../tools/testers/solomon_100_rc101.data.sql
-
-VROOM Data
--------------------------------------------------------------------------------
-
-Jobs
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- JOBS TABLE start
- :end-before: -- JOBS TABLE end
-
-Jobs Time Windows
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- JOBS TIME WINDOWS TABLE start
- :end-before: -- JOBS TIME WINDOWS TABLE end
-
-Shipments
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- SHIPMENTS TABLE start
- :end-before: -- SHIPMENTS TABLE end
-
-Shipments Time Windows
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- SHIPMENTS TIME WINDOWS TABLE start
- :end-before: -- SHIPMENTS TIME WINDOWS TABLE end
-
-Vehicles
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- VEHICLES TABLE start
- :end-before: -- VEHICLES TABLE end
-
-Breaks
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- BREAKS TABLE start
- :end-before: -- BREAKS TABLE end
-
-Breaks Time Windows
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- BREAKS TIME WINDOWS TABLE start
- :end-before: -- BREAKS TIME WINDOWS TABLE end
-
-Matrix
-...............................................................................
-
-.. literalinclude:: ../../tools/testers/vroomdata.sql
- :start-after: -- MATRIX TABLE start
- :end-before: -- MATRIX TABLE end
-
-Modified VROOM Data
--------------------------------------------------------------------------------
-
-The tables created using the above VROOM Data are modified for the VROOM functions
-with timestamps/interval, as:
-
-.. literalinclude:: ../../docqueries/vroom/vroom.pg
- :start-after: -- q0
- :end-before: -- q1
-
-Images
--------------------------------------------------------------------------------
-
-* Red arrows correspond when ``cost`` > 0 in the edge table.
-* Blue arrows correspond when ``reverse_cost`` > 0 in the edge table.
-* Points are outside the graph.
-* Click on the graph to enlarge.
-
-.. _fig1:
-
-Currently VRP functions work on an undirected graph
-
-.. figure:: /images/Fig6-undirected.png
-
diff --git a/doc/general/support.rst b/doc/general/support.rst
index 7b5d02f0e..ff1f30a6f 100644
--- a/doc/general/support.rst
+++ b/doc/general/support.rst
@@ -55,7 +55,7 @@ Mailing List and GIS StackExchange
There are two mailing lists for vrpRouting hosted on OSGeo mailing list server
which are of pgRouting:
-* User mailing list: https://lists.osgeo.org/mailman/listinfo/pgrouting-users
+* User's mailing list: https://discourse.osgeo.org/c/pgrouting/pgrouting-users
* Developer mailing list: https://discourse.osgeo.org/c/pgrouting/pgrouting-dev
For general questions and topics about how to use vrpRouting, please write to the user mailing list.
@@ -81,9 +81,9 @@ contributed to the development of vrpRouting:
* - **Company**
- **Offices in**
- **Website**
- * - Georepublic
- - Germany, Japan
- - https://georepublic.info
+ * - erosion developers
+ - Mexico
+ - https://erosion.dev
* - Paragon Corporation
- United States
- https://www.paragoncorporation.com
diff --git a/doc/general/vroom-category.rst b/doc/general/vroom-category.rst
deleted file mode 100644
index 4f87b59cd..000000000
--- a/doc/general/vroom-category.rst
+++ /dev/null
@@ -1,195 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-VROOM - Category (Experimental)
-===============================================================================
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-
-.. contents::
-
-.. rubric:: Functions
-
-.. toctree::
- :maxdepth: 1
-
- vrp_vroom
- vrp_vroomJobs
- vrp_vroomShipments
- vrp_vroomPlain
- vrp_vroomJobsPlain
- vrp_vroomShipmentsPlain
-
-
-Synopsis
--------------------------------------------------------------------------------
-
-VROOM is an open-source optimization engine that aims at providing good solutions
-to various real-life vehicle routing problems (VRP) within a small computing time.
-
-VROOM can solve several well-known types of vehicle routing problems (VRP).
-
-- TSP (travelling salesman problem)
-- CVRP (capacitated VRP)
-- VRPTW (VRP with time windows)
-- MDHVRPTW (multi-depot heterogeneous vehicle VRPTW)
-- PDPTW (pickup-and-delivery problem with TW)
-
-VROOM can also solve any mix of the above problem types.
-
-
-Characteristics
-...............................................................................
-
-VROOM models a Vehicle Routing Problem with ``vehicles``, ``jobs`` and ``shipments``.
-
-The **vehicles** denote the resources that pick and/or deliver the jobs and shipments.
-They are characterised by:
-
-- Capacity on arbitrary number of metrics
-- Skills
-- Working hours
-- Driver breaks
-- Start and end defined on a per-vehicle basis
-- Start and end can be different
-- Open trip optimization (only start or only end defined)
-
-The **jobs** denote the single-location pickup and/or delivery tasks, and the **shipments**
-denote the pickup-and-delivery tasks that should happen within the same route.
-They are characterised by:
-
-- Delivery/pickup amounts on arbitrary number of metrics
-- Service time windows
-- Service duration
-- Skills
-- Priority
-
-Terminologies
-...............................................................................
-
-- **Tasks**: Either jobs or shipments are referred to as tasks.
-- **Skills**: Every task and vehicle may have some set of skills. A task can be
- served by only that vehicle which has all the skills of the task.
-- **Priority**: Tasks may have some priority assigned, which is useful when all
- tasks cannot be performed due to constraints, so the tasks with low priority
- are left unassigned.
-- **Amount (for shipment), Pickup and delivery (for job)**: They denote the
- multidimensional quantities such as number of items, weights, volume, etc.
-- **Capacity (for vehicle)**: Every vehicle may have some capacity, denoting the
- multidimensional quantities. A vehicle can serve only those sets of tasks such
- that the total sum of the quantity does not exceed the vehicle capacity, at
- any point of the route.
-- **Time Window**: An interval of time during which some activity can be
- performed, such as working hours of the vehicle, break of the vehicle, or
- service start time for a task.
-- **Break**: Array of time windows, denoting valid slots for the break start of
- a vehicle.
-- **Setup time**: Setup times serve as a mean to describe the time it takes to
- get started for a task at a given location.
- This models a duration that should not be re-applied for other tasks following
- at the same place.
- So the total "action time" for a task is ``setup + service`` upon arriving at
- a new location or ``service`` only if performing a new task at the previous
- vehicle location.
-- **Service time**: The additional time to be spent by a vehicle while serving a
- task.
-- **Travel time**: The total time the vehicle travels during its route.
-- **Waiting time**: The total time the vehicle is idle, i.e. it is neither
- traveling nor servicing any task. It is generally the time spent by a vehicle
- waiting for a task service to open.
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Jobs SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: jobs_start
- :end-before: jobs_end
-
-Shipments SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_start
- :end-before: shipments_end
-
-.. inner_queries_start
-
-Vehicles SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_vehicles_start
- :end-before: vroom_vehicles_end
-
-Breaks SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: breaks_start
- :end-before: breaks_end
-
-Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: time_windows_start
- :end-before: time_windows_end
-
-Time Matrix SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_matrix_start
- :end-before: vroom_matrix_end
-
-.. inner_queries_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. include:: concepts.rst
- :start-after: vroom_result_start
- :end-before: vroom_result_end
-
-See Also
--------------------------------------------------------------------------------
-
-.. see_also_start
-
-* `Wikipedia: Vehicle Routing problems `__
-* `VROOM: Vehicle Routing Open-source Optimization Machine `__
-* `VROOM API Documentation `__
-
-.. see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
-.. |interval| replace:: :abbr:`ANY-INTERVAL(INTERVAL, SMALLINT, INTEGER, BIGINT)`
-.. |interval0| replace:: :abbr:`INTERVAL 0('make_interval(secs => 0), 0)`
-.. |intervalmax| replace:: **INTERVAL**: ``make_interval(secs => 4294967295)`` and |br| |ANY-INTEGER|: :math:`4294967295`
-.. |timestamp| replace:: :abbr:`ANY-TIMESTAMP(TIMESTAMP, SMALLINT, INTEGER, BIGINT)`
-.. |tw_open_default| replace:: :abbr:`TW-OPEN-DEFAULT(to_timestamp(0), 0)`
-.. |tw_close_default| replace:: :abbr:`TW-CLOSE-DEFAULT(to_timestamp(4294967295), 4294967295)`
diff --git a/doc/images/CMakeLists.txt b/doc/images/CMakeLists.txt
deleted file mode 100644
index a1e32a9cf..000000000
--- a/doc/images/CMakeLists.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-
-SET(LOCAL_FILES
- Fig1-originalData.png
- Fig2-cost.png
- Fig4-costUndirected.png
- Fig6-undirected.png
- parallelImage.png
- test1.png
- trsp-test-image.png
- )
-
-foreach (f ${LOCAL_FILES})
- configure_file(${f} "${f}" COPYONLY)
- list(APPEND LOCAL_IMG_FILES ${CMAKE_CURRENT_BINARY_DIR}/${f})
-endforeach()
-
-set(PROJECT_IMG_FILES ${PROJECT_IMG_FILES} ${LOCAL_IMG_FILES} PARENT_SCOPE)
-
diff --git a/doc/images/Fig1-originalData.png b/doc/images/Fig1-originalData.png
deleted file mode 100644
index f76fcd810..000000000
Binary files a/doc/images/Fig1-originalData.png and /dev/null differ
diff --git a/doc/images/Fig2-cost.png b/doc/images/Fig2-cost.png
deleted file mode 100644
index 13307afac..000000000
Binary files a/doc/images/Fig2-cost.png and /dev/null differ
diff --git a/doc/images/Fig4-costUndirected.png b/doc/images/Fig4-costUndirected.png
deleted file mode 100644
index 17e704061..000000000
Binary files a/doc/images/Fig4-costUndirected.png and /dev/null differ
diff --git a/doc/images/Fig6-undirected.png b/doc/images/Fig6-undirected.png
deleted file mode 100644
index 6272a4379..000000000
Binary files a/doc/images/Fig6-undirected.png and /dev/null differ
diff --git a/doc/images/parallelImage.png b/doc/images/parallelImage.png
deleted file mode 100644
index 7469c29a3..000000000
Binary files a/doc/images/parallelImage.png and /dev/null differ
diff --git a/doc/images/test1.png b/doc/images/test1.png
deleted file mode 100644
index 4b8e08d3e..000000000
Binary files a/doc/images/test1.png and /dev/null differ
diff --git a/doc/images/trsp-test-image.png b/doc/images/trsp-test-image.png
deleted file mode 100644
index e4cd594ad..000000000
Binary files a/doc/images/trsp-test-image.png and /dev/null differ
diff --git a/doc/or_tools/CMakeLists.txt b/doc/or_tools/CMakeLists.txt
deleted file mode 100644
index 2c0c9fb51..000000000
--- a/doc/or_tools/CMakeLists.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-SET(LOCAL_FILES
- vrp_knapsack.rst
- vrp_multiple_knapsack.rst
- vrp_bin_packing.rst
- )
-
-foreach (f ${LOCAL_FILES})
- configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
- list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
-endforeach()
-
-set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
-set(PROJECT_IMG_FILES ${PROJECT_IMG_FILES} PARENT_SCOPE)
diff --git a/doc/or_tools/vrp_bin_packing.rst b/doc/or_tools/vrp_bin_packing.rst
deleted file mode 100644
index 228a75522..000000000
--- a/doc/or_tools/vrp_bin_packing.rst
+++ /dev/null
@@ -1,150 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-vrp_bin_packing - Experimental
-===============================================================================
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.4.1
-
-* Support for or-tools v9.10.4067
-
-Version 0.4.0
-
-* New **experimental** function
-
- * vrp_knapsack
-
-
-
-Description
--------------------------------------------------------------------------------
-
-The bin packing problem is an optimization problem, in which
-items of different sizes must be packed into a finite number of bins or containers,
-each of a fixed given capacity, in a way that minimizes the number of bins used.
-The problem has many applications, such as filling up containers, loading trucks with weight capacity constraints,
-creating file backups in media and technology mapping in FPGA semiconductor chip design.
-
-
-Signatures
--------------------------------------------------------------------------------
-
-.. rubric:: Summary
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_bin_packing(`Weights SQL`_, bin_capacity, [``max_rows``])
- | Returns set of (bin_number, item_id)
- | OR EMPTY SET
-
-Parameters
--------------------------------------------------------------------------------
-
-.. list-table::
- :width: 81
- :widths: 14 14 44
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - `Weights SQL`_
- - ``TEXT``
- - `Weights SQL`_ as described below
- * - bin_capacity
- - **ANY-INTEGER**
- - Maximum Capacity of the bin.
-
-Optional Parameters
-...............................................................................
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- * - Column
- - Type
- - Default
- - Description
- * - ``max_rows``
- - **ANY-INTEGER**
- - :math:`100000`
- - Maximum items(rows) to fetch from bin_packing_data table.
-
-Where:
-
-:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Weights SQL
-...............................................................................
-
-
-.. include:: or_tools-category.rst
- :start-after: weights_start
- :end-before: weights_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - ``bin``
- - **ANY-INTEGER**
- - Integer to uniquely identify a bin.
- * - ``id``
- - **ANY-INTEGER**
- - Indentifier of an item in the ``bin``.
-
-Where:
-
-:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
-
-Example
--------------------------------------------------------------------------------
-
-.. literalinclude:: bin_packing.queries
- :start-after: -- example_start
- :end-before: -- example_end
-
-See Also
--------------------------------------------------------------------------------
-
-.. include:: or_tools-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
diff --git a/doc/or_tools/vrp_knapsack.rst b/doc/or_tools/vrp_knapsack.rst
deleted file mode 100644
index 528339aa9..000000000
--- a/doc/or_tools/vrp_knapsack.rst
+++ /dev/null
@@ -1,141 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-vrp_knapsack - Experimental
-===============================================================================
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.4.1
-
-* Support for or-tools v9.10.4067
-
-Version 0.4.0
-
-* New **experimental** function
-
- * vrp_knapsack
-
-
-
-Description
--------------------------------------------------------------------------------
-
-The knapsack problem is a problem in combinatorial optimization:
-Given a set of items, each with a weight and a value,
-Determine the number of each item to include in a collection
-so that the total weight is less than or equal to a given limit and the total
-value is as large as possible
-
-Signatures
--------------------------------------------------------------------------------
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_knapsack(`Weight Costs SQL`_, capacity, [``max_rows``])
- | RETURNS SET OF (item_id)
- | OR EMPTY SET
-
-Parameters
--------------------------------------------------------------------------------
-
-.. list-table::
- :width: 81
- :widths: 14 14 44
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - `Weight Costs SQL`_
- - ``TEXT``
- - `Weight Costs SQL`_ as described below.
- * - capacity
- - **ANY-INTEGER**
- - Maximum Capacity of the knapsack.
-
-Optional Parameters
-...............................................................................
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- * - Column
- - Type
- - Default
- - Description
- * - ``max_rows``
- - **ANY-INTEGER**
- - :math:`100000`
- - Maximum items(rows) to fetch from knapsack_data table.
-
-Where:
-
-:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Weight Costs SQL
-...............................................................................
-
-.. include:: or_tools-category.rst
- :start-after: weight_costs_start
- :end-before: weight_costs_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - ``id``
- - ``INTEGER``
- - Indentifier of an item in the knapsack.
-
-Where:
-
-:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
-
-Example
--------------------------------------------------------------------------------
-
-.. literalinclude:: knapsack.queries
- :start-after: -- example_start
- :end-before: -- example_end
-
-See Also
--------------------------------------------------------------------------------
-
-* `OR-Tools: Google OR-Tools `__
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
diff --git a/doc/or_tools/vrp_multiple_knapsack.rst b/doc/or_tools/vrp_multiple_knapsack.rst
deleted file mode 100644
index 379bab5e6..000000000
--- a/doc/or_tools/vrp_multiple_knapsack.rst
+++ /dev/null
@@ -1,136 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-vrp_multiple_knapsack - Experimental
-===============================================================================
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.4.1
-
-* Support for or-tools v9.10.4067
-
-Version 0.4.0
-
-* New **experimental** function
-
- * vrp_knapsack
-
-
-
-Description
--------------------------------------------------------------------------------
-
-The multiple knapsack problem is a problem in combinatorial optimization:
-it is a more general verison of the classic knapsack problem where instead of a
-single knapsack, you will be given multiple knapsacks and your goal is maximise the total
-value of packed items in all knapsacks.
-
-Signatures
--------------------------------------------------------------------------------
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_multiple_knapsack(`Weight Costs SQL`_, capacities, [,``max_rows``])
- | RETURNS SET OF (knapsack, id)
- | OR EMPTY SET
-
-Parameters
--------------------------------------------------------------------------------
-
-.. list-table::
- :width: 81
- :widths: 14 14 44
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - `Weight Costs SQL`_
- - ``TEXT``
- - `Weight Costs SQL`_ as described below
- * - capacities
- - ``ARRAY[`` **ANY-INTEGER** ``]``
- - An array describing the capacity of each knapsack.
-
-Optional Parameters
-...............................................................................
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- * - Column
- - Type
- - Default
- - Description
- * - ``max_rows``
- - **ANY-INTEGER**
- - :math:`100000`
- - Maximum items(rows) to fetch from bin_packing_data table.
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Weight Costs SQL
-...............................................................................
-
-.. include:: or_tools-category.rst
- :start-after: weight_costs_start
- :end-before: weight_costs_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. list-table::
- :width: 81
- :widths: auto
- :header-rows: 1
-
- * - Column
- - Type
- - Description
- * - ``knapsak``
- - ``INTEGER``
- - Indentifier of the knapsack.
- * - ``id``
- - ``INTEGER``
- - Indentifier of an item in the ``knapsack``.
-
-Example
--------------------------------------------------------------------------------
-
-.. literalinclude:: multiple_knapsack.queries
- :start-after: -- example_start
- :end-before: -- example_end
-
-See Also
--------------------------------------------------------------------------------
-
-.. include:: or_tools-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
diff --git a/doc/pgr_pickDeliver/vrp_oneDepot.rst b/doc/pgr_pickDeliver/vrp_oneDepot.rst
index d1d9d0224..f4bb95577 100644
--- a/doc/pgr_pickDeliver/vrp_oneDepot.rst
+++ b/doc/pgr_pickDeliver/vrp_oneDepot.rst
@@ -9,18 +9,12 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
+.. index::
+ single: oneDepot
vrp_oneDepot - Experimental
===============================================================================
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
.. rubric:: Availability
Version 0.4.1
diff --git a/doc/pgr_pickDeliver/vrp_pgr_pickDeliver.rst b/doc/pgr_pickDeliver/vrp_pgr_pickDeliver.rst
index d0a89c44e..b6e62dd5a 100644
--- a/doc/pgr_pickDeliver/vrp_pgr_pickDeliver.rst
+++ b/doc/pgr_pickDeliver/vrp_pgr_pickDeliver.rst
@@ -9,21 +9,15 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
+.. index::
+ single: migrated ; vrp_pgr_pickDeliver
+ single: pgr_pickDeliver
vrp_pgr_pickDeliver - Experimental
===============================================================================
``vrp_pgr_pickDeliver`` - Pickup and delivery Vehicle Routing Problem
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
.. rubric:: Availability
Version 0.0.0
@@ -199,7 +193,6 @@ This example use the following data:
See Also
-------------------------------------------------------------------------------
-* :doc:`pgr-category`
* The queries use the :doc:`sampledata` network.
.. rubric:: Indices and tables
diff --git a/doc/pgr_pickDeliver/vrp_pgr_pickDeliverEuclidean.rst b/doc/pgr_pickDeliver/vrp_pgr_pickDeliverEuclidean.rst
index 28afd549f..924392bb2 100644
--- a/doc/pgr_pickDeliver/vrp_pgr_pickDeliverEuclidean.rst
+++ b/doc/pgr_pickDeliver/vrp_pgr_pickDeliverEuclidean.rst
@@ -9,20 +9,15 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
+.. index::
+ single: migrated ; vrp_pgr_pickDeliverEuclidean
+ single: pgr_pickDeliverEuclidean
vrp_pgr_pickDeliverEuclidean - Experimental
===============================================================================
``vrp_pgr_pickDeliverEuclidean`` - Pickup and delivery Vehicle Routing Problem
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
.. rubric:: Availability
Version 0.0.0
@@ -194,11 +189,9 @@ This example use the following data:
.. rubric:: See Also
-* :doc:`pgr-category`
* The queries use the :doc:`sampledata` network.
.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`search`
-
diff --git a/doc/version/vrp_full_version.rst b/doc/version/vrp_full_version.rst
index b4de69df4..ba0964720 100644
--- a/doc/version/vrp_full_version.rst
+++ b/doc/version/vrp_full_version.rst
@@ -9,10 +9,9 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions:
- `Latest `__
- (`v0 `__)
+.. index::
+ single: utilities ; vrp_full_version
+ single: full_version
vrp_full_version
===============================================================================
diff --git a/doc/version/vrp_version.rst b/doc/version/vrp_version.rst
index 7f18e7292..4f2815c41 100644
--- a/doc/version/vrp_version.rst
+++ b/doc/version/vrp_version.rst
@@ -9,10 +9,9 @@
|
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
+.. index::
+ single: utilities ; vrp_version
+ single: version
vrp_version
===============================================================================
diff --git a/doc/vroom/CMakeLists.txt b/doc/vroom/CMakeLists.txt
deleted file mode 100644
index c8d650c18..000000000
--- a/doc/vroom/CMakeLists.txt
+++ /dev/null
@@ -1,17 +0,0 @@
-
-SET(LOCAL_FILES
- vrp_vroom.rst
- vrp_vroomJobs.rst
- vrp_vroomShipments.rst
- vrp_vroomPlain.rst
- vrp_vroomJobsPlain.rst
- vrp_vroomShipmentsPlain.rst
- )
-
-foreach (f ${LOCAL_FILES})
- configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
- list(APPEND LOCAL_DOC_FILES ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
-endforeach()
-
-set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
-set(PROJECT_IMG_FILES ${PROJECT_IMG_FILES} PARENT_SCOPE)
diff --git a/doc/vroom/vrp_vroom.rst b/doc/vroom/vrp_vroom.rst
deleted file mode 100644
index 282dbaa75..000000000
--- a/doc/vroom/vrp_vroom.rst
+++ /dev/null
@@ -1,240 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-vrp_vroom - Experimental
-===============================================================================
-
-``vrp_vroom`` - Vehicle Routing Problem with VROOM, involving both jobs and shipments.
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.3.0
-
-* Function **modified** for VROOM 1.11.0
-
-Version 0.2.0
-
-* New **experimental** function
-
-
-Description
--------------------------------------------------------------------------------
-
-VROOM is an open-source optimization engine that aims at providing good solutions
-to various real-life vehicle routing problems (VRP) within a small computing time.
-This function can be used to get the solution to a problem involving both jobs and
-shipments.
-
-.. index::
- single: vrp_vroom -- Experimental on v0.2
-
-Signature
--------------------------------------------------------------------------------
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_vroom(
- | `Jobs SQL`_, `Jobs Time Windows SQL`_,
- | `Shipments SQL`_, `Shipments Time Windows SQL`_,
- | `Vehicles SQL`_,
- | `Breaks SQL`_, `Breaks Time Windows SQL`_,
- | `Time Matrix SQL`_
- | [, exploration_level] [, timeout]) -- Experimental on v0.2
- | RETURNS SET OF
- | (seq, vehicle_seq, vehicle_id, vehicle_data, step_seq, step_type, task_id,
- | task_data, arrival, travel_time, service_time, waiting_time, departure, load)
-
-
-**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
-The modification in the tables is mentioned at the end of the :doc:`sampledata`.
-
-.. literalinclude:: vroom.queries
- :start-after: -- q1
- :end-before: -- q2
-
-Parameters
--------------------------------------------------------------------------------
-
-.. vroom_parameters_start
-
-.. list-table::
- :widths: auto
- :header-rows: 1
-
- - - Parameter
- - Type
- - Description
- - - `Jobs SQL`_
- - ``TEXT``
- - Query describing the single-location pickup and/or delivery
- - - `Jobs Time Windows SQL`_
- - ``TEXT``
- - Query describing valid slots for job service start.
- - - `Shipments SQL`_
- - ``TEXT``
- - Query describing pickup and delivery tasks that should happen within same route.
- - - `Shipments Time Windows SQL`_
- - ``TEXT``
- - Query describing valid slots for pickup and delivery service start.
- - - `Vehicles SQL`_
- - ``TEXT``
- - Query describing the available vehicles.
- - - `Breaks SQL`_
- - ``TEXT``
- - Query describing the driver breaks.
- - - `Breaks Time Windows SQL`_
- - ``TEXT``
- - Query describing valid slots for break start.
- - - `Time Matrix SQL`_
- - ``TEXT``
- - Query containing the distance or travel times between the locations.
-
-.. vroom_parameters_end
-
-Optional Parameters
-...............................................................................
-
-.. vroom_optionals_start
-
-.. list-table::
- :widths: auto
- :header-rows: 1
-
- - - Parameter
- - Type
- - Default
- - Description
- - - ``exploration_level``
- - ``INTEGER``
- - :math:`5`
- - Exploration level to use while solving.
-
- - Ranges from ``[0, 5]``
- - A smaller exploration level gives faster result.
- - - ``timeout``
- - ``INTERVAL``
- - '-00:00:01'::INTERVAL
- - Timeout value to stop the solving process.
-
- - Gives the best possible solution within a time limit. Note that some
- additional seconds may be required to return back the data.
- - Any negative timeout value is ignored.
-
-.. vroom_optionals_end
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Jobs SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: jobs_start
- :end-before: jobs_end
-
-Jobs Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Shipments SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_start
- :end-before: shipments_end
-
-Shipments Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_time_windows_start
- :end-before: shipments_time_windows_end
-
-Vehicles SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_vehicles_start
- :end-before: vroom_vehicles_end
-
-Breaks SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: breaks_start
- :end-before: breaks_end
-
-Breaks Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Time Matrix SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_matrix_start
- :end-before: vroom_matrix_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. include:: concepts.rst
- :start-after: vroom_result_start
- :end-before: vroom_result_end
-
-Additional Example
--------------------------------------------------------------------------------
-
-Problem involving 2 jobs and 1 shipment, using a single vehicle, similar to the VROOM Documentation
-`Example 2 `__ with a shipment.
-
-.. literalinclude:: vroom.queries
- :start-after: -- q2
- :end-before: -- q3
-
-See Also
--------------------------------------------------------------------------------
-
-* :doc:`vroom-category`
-* The queries use the :doc:`sampledata` network.
-
-.. include:: vroom-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
-.. |interval| replace:: ``INTERVAL``
-.. |interval0| replace:: ``make_interval(secs => 0)``
-.. |intervalmax| replace:: ``make_interval(secs => 4294967295)``
-.. |timestamp| replace:: ``TIMESTAMP``
-.. |tw_open_default| replace:: ``to_timestamp(0)``
-.. |tw_close_default| replace:: ``to_timestamp(4294967295)``
diff --git a/doc/vroom/vrp_vroomJobs.rst b/doc/vroom/vrp_vroomJobs.rst
deleted file mode 100644
index 8dcb54cae..000000000
--- a/doc/vroom/vrp_vroomJobs.rst
+++ /dev/null
@@ -1,193 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-vrp_vroomJobs - Experimental
-===============================================================================
-
-``vrp_vroomJobs`` - Vehicle Routing Problem with VROOM, involving only jobs.
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.3.0
-
-* Function **modified** for VROOM 1.11.0
-
-Version 0.2.0
-
-* New **experimental** function
-
-
-Description
--------------------------------------------------------------------------------
-
-VROOM is an open-source optimization engine that aims at providing good solutions
-to various real-life vehicle routing problems (VRP) within a small computing time.
-This function can be used to get the solution to a problem involving only jobs.
-
-.. index::
- single: vrp_vroomJobs -- Experimental on v0.2
-
-Signature
--------------------------------------------------------------------------------
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_vroom(
- | `Jobs SQL`_, `Jobs Time Windows SQL`_,
- | `Vehicles SQL`_,
- | `Breaks SQL`_, `Breaks Time Windows SQL`_,
- | `Time Matrix SQL`_
- | [, exploration_level] [, timeout]) -- Experimental on v0.2
- | RETURNS SET OF
- | (seq, vehicle_seq, vehicle_id, vehicle_data, step_seq, step_type, task_id,
- | task_data, arrival, travel_time, service_time, waiting_time, departure, load)
-
-**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
-The modification in the tables is mentioned at the end of the :doc:`sampledata`.
-
-.. literalinclude:: vroomJobs.queries
- :start-after: -- q1
- :end-before: -- q2
-
-Parameters
--------------------------------------------------------------------------------
-
-.. vjobs_parameter_start
-
-.. list-table::
- :widths: auto
- :header-rows: 1
-
- - - Parameter
- - Type
- - Description
- - - `Jobs SQL`_
- - ``TEXT``
- - Query describing the single-location pickup and/or delivery
- - - `Jobs Time Windows SQL`_
- - ``TEXT``
- - Query describing valid slots for job service start.
- - - `Vehicles SQL`_
- - ``TEXT``
- - Query describing the available vehicles.
- - - `Breaks SQL`_
- - ``TEXT``
- - Query describing the driver breaks.
- - - `Breaks Time Windows SQL`_
- - ``TEXT``
- - Query describing valid slots for break start.
- - - `Time Matrix SQL`_
- - ``TEXT``
- - Query containing the distance or travel times between the locations.
-
-.. vjobs_parameter_end
-
-Optional Parameters
-...............................................................................
-
-.. include:: vrp_vroom.rst
- :start-after: vroom_optionals_start
- :end-before: vroom_optionals_end
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Jobs SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: jobs_start
- :end-before: jobs_end
-
-Jobs Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Vehicles SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_vehicles_start
- :end-before: vroom_vehicles_end
-
-Breaks SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: breaks_start
- :end-before: breaks_end
-
-Breaks Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Time Matrix SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_matrix_start
- :end-before: vroom_matrix_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. include:: concepts.rst
- :start-after: vroom_result_start
- :end-before: vroom_result_end
-
-Additional Example
--------------------------------------------------------------------------------
-
-Problem involving 2 jobs, using a single vehicle, corresponding to the VROOM Documentation
-`Example 2 `__.
-
-.. literalinclude:: vroomJobs.queries
- :start-after: -- q2
- :end-before: -- q3
-
-See Also
--------------------------------------------------------------------------------
-
-* :doc:`vroom-category`
-* The queries use the :doc:`sampledata` network.
-
-.. include:: vroom-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
-.. |interval| replace:: ``INTERVAL``
-.. |interval0| replace:: ``make_interval(secs => 0)``
-.. |intervalmax| replace:: ``make_interval(secs => 4294967295)``
-.. |timestamp| replace:: ``TIMESTAMP``
-.. |tw_open_default| replace:: ``to_timestamp(0)``
-.. |tw_close_default| replace:: ``to_timestamp(4294967295)``
diff --git a/doc/vroom/vrp_vroomJobsPlain.rst b/doc/vroom/vrp_vroomJobsPlain.rst
deleted file mode 100644
index 2a6f454c5..000000000
--- a/doc/vroom/vrp_vroomJobsPlain.rst
+++ /dev/null
@@ -1,168 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-vrp_vroomJobsPlain - Experimental
-===============================================================================
-
-``vrp_vroomJobsPlain`` - Vehicle Routing Problem with VROOM, involving only
-jobs, with plain integer values instead of TIMESTAMP or INTERVAL.
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.3.0
-
-* Function **modified** for VROOM 1.11.0
-
-Version 0.2.0
-
-* New **experimental** function
-
-
-Description
--------------------------------------------------------------------------------
-
-VROOM is an open-source optimization engine that aims at providing good solutions
-to various real-life vehicle routing problems (VRP) within a small computing time.
-This function can be used to get the solution to a problem involving only jobs.
-
-.. index::
- single: vrp_vroomJobsPlain -- Experimental on v0.2
-
-Signature
--------------------------------------------------------------------------------
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_vroom(
- | `Jobs SQL`_, `Jobs Time Windows SQL`_,
- | `Vehicles SQL`_,
- | `Breaks SQL`_, `Breaks Time Windows SQL`_,
- | `Time Matrix SQL`_
- | [, exploration_level] [, timeout]) -- Experimental on v0.2
- | RETURNS SET OF
- | (seq, vehicle_seq, vehicle_id, vehicle_data, step_seq, step_type, task_id,
- | task_data, arrival, travel_time, service_time, waiting_time, departure, load)
-
-**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
-
-.. literalinclude:: vroomJobsPlain.queries
- :start-after: -- q1
- :end-before: -- q2
-
-Parameters
--------------------------------------------------------------------------------
-
-.. include:: vrp_vroomJobs.rst
- :start-after: vjobs_parameter_start
- :end-before: vjobs_parameter_end
-
-Optional Parameters
-...............................................................................
-
-.. include:: vrp_vroomPlain.rst
- :start-after: vroom_plain_optionals_start
- :end-before: vroom_plain_optionals_end
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Jobs SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: jobs_start
- :end-before: jobs_end
-
-Jobs Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Vehicles SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_vehicles_start
- :end-before: vroom_vehicles_end
-
-Breaks SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: breaks_start
- :end-before: breaks_end
-
-Breaks Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Time Matrix SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_matrix_start
- :end-before: vroom_matrix_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. include:: concepts.rst
- :start-after: vroom_result_start
- :end-before: vroom_result_end
-
-Additional Example
--------------------------------------------------------------------------------
-
-Problem involving 2 jobs, using a single vehicle, corresponding to the VROOM Documentation
-`Example 2 `__.
-
-.. literalinclude:: vroomJobsPlain.queries
- :start-after: -- q2
- :end-before: -- q3
-
-See Also
--------------------------------------------------------------------------------
-
-* :doc:`vroom-category`
-* The queries use the :doc:`sampledata` network.
-
-.. include:: vroom-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
-.. |interval| replace:: |ANY-INTEGER|
-.. |interval0| replace:: :math:`0`
-.. |intervalmax| replace:: :math:`4294967295`
-.. |timestamp| replace:: |ANY-INTEGER|
-.. |tw_open_default| replace:: :math:`0`
-.. |tw_close_default| replace:: :math:`4294967295`
-
diff --git a/doc/vroom/vrp_vroomPlain.rst b/doc/vroom/vrp_vroomPlain.rst
deleted file mode 100644
index b5478d627..000000000
--- a/doc/vroom/vrp_vroomPlain.rst
+++ /dev/null
@@ -1,207 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-vrp_vroomPlain - Experimental
-===============================================================================
-
-``vrp_vroomPlain`` - Vehicle Routing Problem with VROOM, involving both jobs and
-shipments, with plain integer values instead of TIMESTAMP or INTERVAL.
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.3.0
-
-* Function **modified** for VROOM 1.11.0
-
-Version 0.2.0
-
-* New **experimental** function
-
-
-Description
--------------------------------------------------------------------------------
-
-VROOM is an open-source optimization engine that aims at providing good solutions
-to various real-life vehicle routing problems (VRP) within a small computing time.
-This function can be used to get the solution to a problem involving both jobs and
-shipments.
-
-.. index::
- single: vrp_vroomPlain -- Experimental on v0.2
-
-Signature
--------------------------------------------------------------------------------
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_vroom(
- | `Jobs SQL`_, `Jobs Time Windows SQL`_,
- | `Shipments SQL`_, `Shipments Time Windows SQL`_,
- | `Vehicles SQL`_,
- | `Breaks SQL`_, `Breaks Time Windows SQL`_,
- | `Time Matrix SQL`_
- | [, exploration_level] [, timeout]) -- Experimental on v0.2
- | RETURNS SET OF
- | (seq, vehicle_seq, vehicle_id, vehicle_data, step_seq, step_type, task_id,
- | task_data, arrival, travel_time, service_time, waiting_time, departure, load)
-
-
-**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
-
-.. literalinclude:: vroomPlain.queries
- :start-after: -- q1
- :end-before: -- q2
-
-Parameters
--------------------------------------------------------------------------------
-
-.. include:: vrp_vroom.rst
- :start-after: vroom_parameters_start
- :end-before: vroom_parameters_end
-
-Optional Parameters
-...............................................................................
-
-.. vroom_plain_optionals_start
-
-.. list-table::
- :widths: auto
- :header-rows: 1
-
- - - Parameter
- - Type
- - Default
- - Description
- - - ``exploration_level``
- - ``INTEGER``
- - :math:`5`
- - Exploration level to use while solving.
-
- - Ranges from ``[0, 5]``
- - A smaller exploration level gives faster result.
- - - ``timeout``
- - ``INTEGER``
- - :math:`-1`
- - Timeout value to stop the solving process.
-
- - Gives the best possible solution within a time limit. Note that some
- additional seconds may be required to return back the data.
- - Any negative timeout value is ignored.
-
-.. vroom_plain_optionals_end
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Jobs SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: jobs_start
- :end-before: jobs_end
-
-Jobs Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Shipments SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_start
- :end-before: shipments_end
-
-Shipments Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_time_windows_start
- :end-before: shipments_time_windows_end
-
-Vehicles SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_vehicles_start
- :end-before: vroom_vehicles_end
-
-Breaks SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: breaks_start
- :end-before: breaks_end
-
-Breaks Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Time Matrix SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_matrix_start
- :end-before: vroom_matrix_end
-Result Columns
--------------------------------------------------------------------------------
-
-.. include:: concepts.rst
- :start-after: vroom_result_start
- :end-before: vroom_result_end
-
-Additional Example
--------------------------------------------------------------------------------
-
-Problem involving 2 jobs and 1 shipment, using a single vehicle, similar to the VROOM Documentation
-`Example 2 `__ with a shipment.
-
-.. literalinclude:: vroomPlain.queries
- :start-after: -- q2
- :end-before: -- q3
-
-See Also
--------------------------------------------------------------------------------
-
-* :doc:`vroom-category`
-* The queries use the :doc:`sampledata` network.
-
-.. include:: vroom-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
-.. |interval| replace:: |ANY-INTEGER|
-.. |interval0| replace:: :math:`0`
-.. |intervalmax| replace:: :math:`4294967295`
-.. |timestamp| replace:: |ANY-INTEGER|
-.. |tw_open_default| replace:: :math:`0`
-.. |tw_close_default| replace:: :math:`4294967295`
diff --git a/doc/vroom/vrp_vroomShipments.rst b/doc/vroom/vrp_vroomShipments.rst
deleted file mode 100644
index 68a2d1224..000000000
--- a/doc/vroom/vrp_vroomShipments.rst
+++ /dev/null
@@ -1,194 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-vrp_vroomShipments - Experimental
-===============================================================================
-
-``vrp_vroomShipments`` - Vehicle Routing Problem with VROOM, involving only shipments.
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.3.0
-
-* Function **modified** for VROOM 1.11.0
-
-Version 0.2.0
-
-* New **experimental** function
-
-
-Description
--------------------------------------------------------------------------------
-
-VROOM is an open-source optimization engine that aims at providing good solutions
-to various real-life vehicle routing problems (VRP) within a small computing time.
-This function can be used to get the solution to a problem involving only shipments.
-
-.. index::
- single: vrp_vroomShipments -- Experimental on v0.2
-
-Signature
--------------------------------------------------------------------------------
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_vroomShipments(
- | `Shipments SQL`_, `Shipments Time Windows SQL`_,
- | `Vehicles SQL`_,
- | `Breaks SQL`_, `Breaks Time Windows SQL`_,
- | `Time Matrix SQL`_
- | [, exploration_level] [, timeout]) -- Experimental on v0.2
- | RETURNS SET OF
- | (seq, vehicle_seq, vehicle_id, vehicle_data, step_seq, step_type, task_id,
- | task_data, arrival, travel_time, service_time, waiting_time, departure, load)
-
-**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
-The modification in the tables is mentioned at the end of the :doc:`sampledata`.
-
-.. literalinclude:: vroomShipments.queries
- :start-after: -- q1
- :end-before: -- q2
-
-Parameters
--------------------------------------------------------------------------------
-
-.. vship_parameters_start
-
-.. list-table::
- :widths: auto
- :header-rows: 1
-
- - - Parameter
- - Type
- - Description
- - - `Shipments SQL`_
- - ``TEXT``
- - Query describing pickup and delivery tasks that should happen within same route.
- - - `Shipments Time Windows SQL`_
- - ``TEXT``
- - Query describing valid slots for pickup and delivery service start.
- - - `Vehicles SQL`_
- - ``TEXT``
- - Query describing the available vehicles.
- - - `Breaks SQL`_
- - ``TEXT``
- - Query describing the driver breaks.
- - - `Breaks Time Windows SQL`_
- - ``TEXT``
- - Query describing valid slots for break start.
- - - `Time Matrix SQL`_
- - ``TEXT``
- - Query containing the distance or travel times between the locations.
-
-.. vship_parameters_end
-
-Optional Parameters
-...............................................................................
-
-.. include:: vrp_vroom.rst
- :start-after: vroom_optionals_start
- :end-before: vroom_optionals_end
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Shipments SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_start
- :end-before: shipments_end
-
-Shipments Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_time_windows_start
- :end-before: shipments_time_windows_end
-
-Vehicles SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_vehicles_start
- :end-before: vroom_vehicles_end
-
-Breaks SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: breaks_start
- :end-before: breaks_end
-
-Breaks Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Time Matrix SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_matrix_start
- :end-before: vroom_matrix_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. include:: concepts.rst
- :start-after: vroom_result_start
- :end-before: vroom_result_end
-
-Additional Example
--------------------------------------------------------------------------------
-
-Problem involving 1 shipment, using a single vehicle, similar to the VROOM Documentation
-`Example 2 `__ without jobs
-and with a shipment.
-
-.. literalinclude:: vroomShipments.queries
- :start-after: -- q2
- :end-before: -- q3
-
-See Also
--------------------------------------------------------------------------------
-
-* :doc:`vroom-category`
-* The queries use the :doc:`sampledata` network.
-
-.. include:: vroom-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
-.. |interval| replace:: ``INTERVAL``
-.. |interval0| replace:: ``make_interval(secs => 0)``
-.. |intervalmax| replace:: ``make_interval(secs => 4294967295)``
-.. |timestamp| replace:: ``TIMESTAMP``
-.. |tw_open_default| replace:: ``to_timestamp(0)``
-.. |tw_close_default| replace:: ``to_timestamp(4294967295)``
diff --git a/doc/vroom/vrp_vroomShipmentsPlain.rst b/doc/vroom/vrp_vroomShipmentsPlain.rst
deleted file mode 100644
index 818637757..000000000
--- a/doc/vroom/vrp_vroomShipmentsPlain.rst
+++ /dev/null
@@ -1,170 +0,0 @@
-..
- ****************************************************************************
- vrpRouting Manual
- Copyright(c) vrpRouting Contributors
-
- This documentation is licensed under a Creative Commons Attribution-Share
- Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
- ****************************************************************************
-
-|
-
-* `Documentation `__ → `vrpRouting v0 `__
-* Supported Versions
- `Latest `__
- (`v0 `__)
-
-
-vrp_vroomShipmentsPlain - Experimental
-===============================================================================
-
-``vrp_vroomShipmentsPlain`` - Vehicle Routing Problem with VROOM, involving only
-shipments, with plain integer values instead of TIMESTAMP or INTERVAL.
-
-.. include:: experimental.rst
- :start-after: begin-warn-expr
- :end-before: end-warn-expr
-
-.. rubric:: Availability
-
-Version 0.3.0
-
-* Function **modified** for VROOM 1.11.0
-
-Version 0.2.0
-
-* New **experimental** function
-
-
-Description
--------------------------------------------------------------------------------
-
-VROOM is an open-source optimization engine that aims at providing good solutions
-to various real-life vehicle routing problems (VRP) within a small computing time.
-This function can be used to get the solution to a problem involving only shipments.
-
-.. index::
- single: vrp_vroomShipmentsPlain -- Experimental on v0.2
-
-Signature
--------------------------------------------------------------------------------
-
-
-.. admonition:: \ \
- :class: signatures
-
- | vrp_vroomShipmentsPlain(
- | `Shipments SQL`_, `Shipments Time Windows SQL`_,
- | `Vehicles SQL`_,
- | `Breaks SQL`_, `Breaks Time Windows SQL`_,
- | `Time Matrix SQL`_
- | [, exploration_level] [, timeout]) -- Experimental on v0.2
- | RETURNS SET OF
- | (seq, vehicle_seq, vehicle_id, vehicle_data, step_seq, step_type, task_id,
- | task_data, arrival, travel_time, service_time, waiting_time, departure, load)
-
-
-**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
-
-.. literalinclude:: vroomShipmentsPlain.queries
- :start-after: -- q1
- :end-before: -- q2
-
-Parameters
--------------------------------------------------------------------------------
-
-.. include:: vrp_vroomShipments.rst
- :start-after: vship_parameters_start
- :end-before: vship_parameters_end
-
-Optional Parameters
-...............................................................................
-
-.. include:: vrp_vroomPlain.rst
- :start-after: vroom_plain_optionals_start
- :end-before: vroom_plain_optionals_end
-
-Inner Queries
--------------------------------------------------------------------------------
-
-Shipments SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_start
- :end-before: shipments_end
-
-Shipments Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: shipments_time_windows_start
- :end-before: shipments_time_windows_end
-
-Vehicles SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_vehicles_start
- :end-before: vroom_vehicles_end
-
-Breaks SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: breaks_start
- :end-before: breaks_end
-
-Breaks Time Windows SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: general_time_windows_start
- :end-before: general_time_windows_end
-
-Time Matrix SQL
-...............................................................................
-
-.. include:: concepts.rst
- :start-after: vroom_matrix_start
- :end-before: vroom_matrix_end
-
-Result Columns
--------------------------------------------------------------------------------
-
-.. include:: concepts.rst
- :start-after: vroom_result_start
- :end-before: vroom_result_end
-
-Additional Example
--------------------------------------------------------------------------------
-
-Problem involving 1 shipment, using a single vehicle, similar to the VROOM Documentation
-`Example 2 `__ without jobs
-and with a shipment.
-
-.. literalinclude:: vroomShipmentsPlain.queries
- :start-after: -- q2
- :end-before: -- q3
-
-See Also
--------------------------------------------------------------------------------
-
-* :doc:`vroom-category`
-* The queries use the :doc:`sampledata` network.
-
-.. include:: vroom-category.rst
- :start-after: see_also_start
- :end-before: see_also_end
-
-.. rubric:: Indices and tables
-
-* :ref:`genindex`
-* :ref:`search`
-
-.. |interval| replace:: |ANY-INTEGER|
-.. |interval0| replace:: :math:`0`
-.. |intervalmax| replace:: :math:`4294967295`
-.. |timestamp| replace:: |ANY-INTEGER|
-.. |tw_open_default| replace:: :math:`0`
-.. |tw_close_default| replace:: :math:`4294967295`
diff --git a/docqueries/full_version.result b/docqueries/full_version.result
deleted file mode 100644
index 9b8c27a06..000000000
--- a/docqueries/full_version.result
+++ /dev/null
@@ -1,14 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- q1 */
-SELECT version, library FROM pgr_full_version();
- version | library
------------+-----------------
- 3.7.0-dev | pgrouting-3.7.0
-(1 row)
-
-/* -- q2 */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/or_tools/CMakeLists.txt b/docqueries/or_tools/CMakeLists.txt
deleted file mode 100644
index 8f949257f..000000000
--- a/docqueries/or_tools/CMakeLists.txt
+++ /dev/null
@@ -1,11 +0,0 @@
-SET(LOCAL_FILES
- knapsack
- multiple_knapsack
- bin_packing
- )
-
-foreach (f ${LOCAL_FILES})
- configure_file("${f}.result" "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
- list(APPEND LOCAL_DOC_FILES "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
-endforeach()
-set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
diff --git a/docqueries/or_tools/bin_packing.pg b/docqueries/or_tools/bin_packing.pg
deleted file mode 100644
index 1e74987b2..000000000
--- a/docqueries/or_tools/bin_packing.pg
+++ /dev/null
@@ -1,4 +0,0 @@
-/* -- example_start */
-SELECT *
-FROM vrp_bin_packing($$SELECT id, weight FROM ortools.bin_packing$$, 100);
-/* -- example_end */
diff --git a/docqueries/or_tools/bin_packing.result b/docqueries/or_tools/bin_packing.result
deleted file mode 100644
index 27a23ab3b..000000000
--- a/docqueries/or_tools/bin_packing.result
+++ /dev/null
@@ -1,25 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- example_start */
-SELECT *
-FROM vrp_bin_packing($$SELECT id, weight FROM ortools.bin_packing$$, 100);
- bin | id
------+----
- 1 | 1
- 1 | 2
- 1 | 3
- 2 | 4
- 2 | 5
- 2 | 6
- 3 | 7
- 3 | 8
- 4 | 9
- 4 | 10
- 4 | 11
-(11 rows)
-
-/* -- example_end */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/or_tools/knapsack.pg b/docqueries/or_tools/knapsack.pg
deleted file mode 100644
index 91a6c0b34..000000000
--- a/docqueries/or_tools/knapsack.pg
+++ /dev/null
@@ -1,4 +0,0 @@
-/* -- example_start */
-SELECT *
-FROM vrp_knapsack($$SELECT * FROM ortools.knapsack$$, 15);
-/* -- example_end */
diff --git a/docqueries/or_tools/knapsack.result b/docqueries/or_tools/knapsack.result
deleted file mode 100644
index ba1692c89..000000000
--- a/docqueries/or_tools/knapsack.result
+++ /dev/null
@@ -1,18 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- example_start */
-SELECT *
-FROM vrp_knapsack($$SELECT * FROM ortools.knapsack$$, 15);
- id
-----
- 2
- 3
- 4
- 5
-(4 rows)
-
-/* -- example_end */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/or_tools/multiple_knapsack.pg b/docqueries/or_tools/multiple_knapsack.pg
deleted file mode 100644
index b95914c7f..000000000
--- a/docqueries/or_tools/multiple_knapsack.pg
+++ /dev/null
@@ -1,4 +0,0 @@
-/* -- example_start */
-SELECT *
-FROM vrp_multiple_knapsack($$SELECT id, weight, cost FROM ortools.multiple_knapsack$$, ARRAY[100,100,100,100,100]);
-/* -- example_end */
diff --git a/docqueries/or_tools/multiple_knapsack.result b/docqueries/or_tools/multiple_knapsack.result
deleted file mode 100644
index 4e3f4473f..000000000
--- a/docqueries/or_tools/multiple_knapsack.result
+++ /dev/null
@@ -1,26 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- example_start */
-SELECT *
-FROM vrp_multiple_knapsack($$SELECT id, weight, cost FROM ortools.multiple_knapsack$$, ARRAY[100,100,100,100,100]);
- knapsack | id
-----------+----
- 1 | 2
- 1 | 9
- 1 | 11
- 2 | 4
- 2 | 5
- 2 | 10
- 3 | 8
- 3 | 13
- 4 | 3
- 4 | 6
- 5 | 14
- 5 | 15
-(12 rows)
-
-/* -- example_end */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/or_tools/test.conf b/docqueries/or_tools/test.conf
deleted file mode 100644
index a364743f1..000000000
--- a/docqueries/or_tools/test.conf
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/usr/bin/perl -w
-
-%main::tests = (
- 'any' => {
- 'comment' => 'Test for OR-Tools',
- 'activate' => 'true',
- 'tests' => [qw(
- knapsack
- multiple_knapsack
- bin_packing
- )],
-
- 'documentation' => [qw(
- knapsack
- multiple_knapsack
- bin_packing
- )],
-
- 'nottesting' => [qw(
- )]
- },
-);
-
-1;
diff --git a/docqueries/pgr_pickDeliver/pgr_pickDeliver.pg b/docqueries/pgr_pickDeliver/pgr_pickDeliver.pg
index d56e9c096..c073a30ba 100644
--- a/docqueries/pgr_pickDeliver/pgr_pickDeliver.pg
+++ b/docqueries/pgr_pickDeliver/pgr_pickDeliver.pg
@@ -22,7 +22,7 @@ SELECT * FROM vrp_pgr_pickDeliver(
$$ SELECT * FROM orders_1 ORDER BY id $$,
$$ SELECT * FROM vehicles_1 ORDER BY id$$,
$$ SELECT start_vid, end_vid, agg_cost::INTEGER FROM pgr_dijkstraCostMatrix(
- 'SELECT * FROM edge_table ',
+ 'SELECT * FROM edges',
(SELECT array_agg(id) FROM (SELECT p_id AS id FROM orders_1
UNION
SELECT d_id FROM orders_1
diff --git a/docqueries/pgr_pickDeliver/pgr_pickDeliver.result b/docqueries/pgr_pickDeliver/pgr_pickDeliver.result
index fc13874f5..febcd2796 100644
--- a/docqueries/pgr_pickDeliver/pgr_pickDeliver.result
+++ b/docqueries/pgr_pickDeliver/pgr_pickDeliver.result
@@ -22,17 +22,17 @@ SELECT * FROM vrp_pgr_pickDeliver(
);
seq | vehicle_seq | vehicle_id | stop_seq | stop_type | stop_id | order_id | cargo | travel_time | arrival_time | wait_time | service_time | departure_time
-----+-------------+------------+----------+-----------+---------+----------+-------+-------------+--------------+-----------+--------------+----------------
- 1 | 1 | 1 | 1 | 1 | 6 | -1 | 0 | 0 | 0 | 1 | 0 | 1
- 2 | 1 | 1 | 2 | 2 | 5 | 3 | 30 | 1 | 2 | 0 | 3 | 5
- 3 | 1 | 1 | 3 | 3 | 11 | 3 | 0 | 1 | 6 | 0 | 3 | 9
- 4 | 1 | 1 | 4 | 2 | 9 | 2 | 20 | 1 | 10 | 0 | 2 | 12
- 5 | 1 | 1 | 5 | 3 | 4 | 2 | 0 | 1 | 13 | 0 | 3 | 16
- 6 | 1 | 1 | 6 | 6 | 6 | -1 | 0 | 1 | 17 | 0 | 0 | 17
+ 1 | 1 | 1 | 1 | 1 | 6 | -1 | 0 | 0 | 0 | 0 | 0 | 0
+ 2 | 1 | 1 | 2 | 2 | 10 | 1 | 10 | 2 | 2 | 0 | 3 | 5
+ 3 | 1 | 1 | 3 | 2 | 16 | 2 | 30 | 1 | 6 | 0 | 2 | 8
+ 4 | 1 | 1 | 4 | 3 | 15 | 2 | 10 | 1 | 9 | 0 | 3 | 12
+ 5 | 1 | 1 | 5 | 3 | 3 | 1 | 0 | 3 | 15 | 0 | 3 | 18
+ 6 | 1 | 1 | 6 | 6 | 6 | -1 | 0 | 2 | 20 | 0 | 0 | 20
7 | 2 | 2 | 1 | 1 | 6 | -1 | 0 | 0 | 0 | 1 | 0 | 1
- 8 | 2 | 2 | 2 | 2 | 3 | 1 | 10 | 1 | 2 | 0 | 3 | 5
- 9 | 2 | 2 | 3 | 3 | 8 | 1 | 0 | 2 | 7 | 0 | 3 | 10
- 10 | 2 | 2 | 4 | 6 | 6 | -1 | 0 | 2 | 12 | 0 | 0 | 12
- 11 | -2 | 0 | 0 | -1 | -1 | -1 | -1 | 10 | -1 | 2 | 17 | 29
+ 8 | 2 | 2 | 2 | 2 | 7 | 3 | 30 | 1 | 2 | 0 | 3 | 5
+ 9 | 2 | 2 | 3 | 3 | 6 | 3 | 0 | 1 | 6 | 0 | 3 | 9
+ 10 | 2 | 2 | 4 | 6 | 6 | -1 | 0 | 0 | 9 | 0 | 0 | 9
+ 11 | -2 | 0 | 0 | -1 | -1 | -1 | -1 | 11 | -1 | 1 | 17 | 29
(11 rows)
/* --q2 */
@@ -40,7 +40,7 @@ SELECT * FROM vrp_pgr_pickDeliver(
$$ SELECT * FROM orders_1 ORDER BY id $$,
$$ SELECT * FROM vehicles_1 ORDER BY id$$,
$$ SELECT start_vid, end_vid, agg_cost::INTEGER FROM pgr_dijkstraCostMatrix(
- 'SELECT * FROM edge_table ',
+ 'SELECT * FROM edges',
(SELECT array_agg(id) FROM (SELECT p_id AS id FROM orders_1
UNION
SELECT d_id FROM orders_1
@@ -51,15 +51,15 @@ SELECT * FROM vrp_pgr_pickDeliver(
seq | vehicle_seq | vehicle_id | stop_seq | stop_type | stop_id | order_id | cargo | travel_time | arrival_time | wait_time | service_time | departure_time
-----+-------------+------------+----------+-----------+---------+----------+-------+-------------+--------------+-----------+--------------+----------------
1 | 1 | 1 | 1 | 1 | 6 | -1 | 0 | 0 | 0 | 1 | 0 | 1
- 2 | 1 | 1 | 2 | 2 | 5 | 3 | 30 | 1 | 2 | 0 | 3 | 5
- 3 | 1 | 1 | 3 | 3 | 11 | 3 | 0 | 2 | 7 | 0 | 3 | 10
- 4 | 1 | 1 | 4 | 2 | 9 | 2 | 20 | 2 | 12 | 0 | 2 | 14
- 5 | 1 | 1 | 5 | 3 | 4 | 2 | 0 | 1 | 15 | 0 | 3 | 18
- 6 | 1 | 1 | 6 | 6 | 6 | -1 | 0 | 2 | 20 | 0 | 0 | 20
+ 2 | 1 | 1 | 2 | 2 | 7 | 3 | 30 | 1 | 2 | 0 | 3 | 5
+ 3 | 1 | 1 | 3 | 2 | 16 | 2 | 50 | 2 | 7 | 0 | 2 | 9
+ 4 | 1 | 1 | 4 | 3 | 15 | 2 | 30 | 1 | 10 | 0 | 3 | 13
+ 5 | 1 | 1 | 5 | 3 | 6 | 3 | 0 | 2 | 15 | 0 | 3 | 18
+ 6 | 1 | 1 | 6 | 6 | 6 | -1 | 0 | 0 | 18 | 0 | 0 | 18
7 | 2 | 2 | 1 | 1 | 6 | -1 | 0 | 0 | 0 | 0 | 0 | 0
- 8 | 2 | 2 | 2 | 2 | 3 | 1 | 10 | 3 | 3 | 0 | 3 | 6
- 9 | 2 | 2 | 3 | 3 | 8 | 1 | 0 | 3 | 9 | 0 | 3 | 12
- 10 | 2 | 2 | 4 | 6 | 6 | -1 | 0 | 2 | 14 | 0 | 0 | 14
+ 8 | 2 | 2 | 2 | 2 | 10 | 1 | 10 | 5 | 5 | 0 | 3 | 8
+ 9 | 2 | 2 | 3 | 3 | 3 | 1 | 0 | 3 | 11 | 0 | 3 | 14
+ 10 | 2 | 2 | 4 | 6 | 6 | -1 | 0 | 2 | 16 | 0 | 0 | 16
11 | -2 | 0 | 0 | -1 | -1 | -1 | -1 | 16 | -1 | 1 | 17 | 34
(11 rows)
diff --git a/docqueries/test.conf b/docqueries/test.conf
deleted file mode 100644
index 54c89cf12..000000000
--- a/docqueries/test.conf
+++ /dev/null
@@ -1,12 +0,0 @@
-#!/usr/bin/perl -w
-
-%main::tests = (
- 'any' => {
- 'files' => [qw(
- version.pg
- full_version.pg
- )],
- },
-);
-
-1;
diff --git a/docqueries/version.result b/docqueries/version.result
deleted file mode 100644
index 6b2356163..000000000
--- a/docqueries/version.result
+++ /dev/null
@@ -1,14 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- q1 */
-SELECT pgr_version();
- pgr_version
--------------
- 3.7.0-dev
-(1 row)
-
-/* -- q2 */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/version/full_version.result b/docqueries/version/full_version.result
index ebb883861..e13a4fba6 100644
--- a/docqueries/version/full_version.result
+++ b/docqueries/version/full_version.result
@@ -6,7 +6,7 @@ SET
SELECT version, library FROM vrp_full_version();
version | library
---------+------------------
- 0.4.2 | vrprouting-0.4.2
+ 0.5.0 | vrprouting-0.5.0
(1 row)
/* -- q2 */
diff --git a/docqueries/version/version.result b/docqueries/version/version.result
index e42f28546..6f0d5c10d 100644
--- a/docqueries/version/version.result
+++ b/docqueries/version/version.result
@@ -6,7 +6,7 @@ SET
SELECT vrp_version();
vrp_version
-------------
- 0.4.2
+ 0.5.0
(1 row)
/* -- q2 */
diff --git a/docqueries/vroom/CMakeLists.txt b/docqueries/vroom/CMakeLists.txt
deleted file mode 100644
index 295dc52c8..000000000
--- a/docqueries/vroom/CMakeLists.txt
+++ /dev/null
@@ -1,16 +0,0 @@
-# Do not use extensions
-SET(LOCAL_FILES
- vroom
- vroomJobs
- vroomShipments
- vroomPlain
- vroomJobsPlain
- vroomShipmentsPlain
- )
-
-foreach (f ${LOCAL_FILES})
- configure_file("${f}.result" "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
- list(APPEND LOCAL_DOC_FILES "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
-endforeach()
-
-set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
diff --git a/docqueries/vroom/test.conf b/docqueries/vroom/test.conf
deleted file mode 100644
index e99144636..000000000
--- a/docqueries/vroom/test.conf
+++ /dev/null
@@ -1,26 +0,0 @@
-#!/usr/bin/perl -w
-
-%main::tests = (
- 'any' => {
- 'comment' => 'VRP with VROOM tests.',
- 'tests' => [qw(
- vroom
- vroomJobs
- vroomShipments
- vroomPlain
- vroomJobsPlain
- vroomShipmentsPlain
- )],
- 'documentation' => [qw(
- vroom
- vroomJobs
- vroomShipments
- vroomPlain
- vroomJobsPlain
- vroomShipmentsPlain
- )]
- },
-
-);
-
-1;
diff --git a/docqueries/vroom/vroom.pg b/docqueries/vroom/vroom.pg
deleted file mode 100644
index debf9646f..000000000
--- a/docqueries/vroom/vroom.pg
+++ /dev/null
@@ -1,62 +0,0 @@
-SET TIMEZONE TO 'UTC';
-SELECT (to_timestamp(1630573200) at time zone 'UTC')::TIMESTAMP;
-
-/* -- q0 */
-ALTER TABLE vroom.jobs ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE vroom.shipments ALTER COLUMN p_service TYPE INTERVAL USING make_interval(secs => p_service);
-ALTER TABLE vroom.shipments ALTER COLUMN d_service TYPE INTERVAL USING make_interval(secs => d_service);
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.matrix ALTER COLUMN duration TYPE INTERVAL USING make_interval(secs => duration);
-
-/* -- q1 */
-SELECT *
-FROM vrp_vroom(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
-/* -- q2 */
-SELECT *
-FROM vrp_vroom(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT start_id, end_id, make_interval(secs => duration) AS duration FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
-/* -- q3 */
diff --git a/docqueries/vroom/vroom.result b/docqueries/vroom/vroom.result
deleted file mode 100644
index 65c396e78..000000000
--- a/docqueries/vroom/vroom.result
+++ /dev/null
@@ -1,133 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-SET TIMEZONE TO 'UTC';
-SET
-SELECT (to_timestamp(1630573200) at time zone 'UTC')::TIMESTAMP;
- timezone
----------------------
- 2021-09-02 09:00:00
-(1 row)
-
-/* -- q0 */
-ALTER TABLE vroom.jobs ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE
-ALTER TABLE vroom.shipments ALTER COLUMN p_service TYPE INTERVAL USING make_interval(secs => p_service);
-ALTER TABLE
-ALTER TABLE vroom.shipments ALTER COLUMN d_service TYPE INTERVAL USING make_interval(secs => d_service);
-ALTER TABLE
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.matrix ALTER COLUMN duration TYPE INTERVAL USING make_interval(secs => duration);
-ALTER TABLE
-/* -- q1 */
-SELECT *
-FROM vrp_vroom(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------------------+-------------+------------+--------------+--------------+---------------------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:05:00 | {30}
- 2 | 1 | 1 | {} | 2 | 5 | 1 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:05:00 | {30}
- 3 | 1 | 1 | {} | 3 | 2 | 2 | 2 | {} | 2021-09-02 09:05:50 | 00:00:50 | 00:00:00 | 00:04:10 | 00:15:00 | 2021-09-02 09:25:00 | {30}
- 4 | 1 | 1 | {} | 4 | 3 | 5 | 2 | {} | 2021-09-02 09:25:00 | 00:00:00 | 00:00:00 | 00:37:30 | 03:17:30 | 2021-09-02 13:20:00 | {40}
- 5 | 1 | 1 | {} | 5 | 3 | 3 | 1 | {} | 2021-09-02 13:20:50 | 00:00:50 | 00:00:00 | 00:37:30 | 00:00:00 | 2021-09-02 13:58:20 | {60}
- 6 | 1 | 1 | {} | 6 | 4 | 5 | 2 | {} | 2021-09-02 13:59:10 | 00:00:50 | 00:00:00 | 00:37:30 | 00:03:45 | 2021-09-02 14:40:25 | {50}
- 7 | 1 | 1 | {} | 7 | 4 | 3 | 2 | {} | 2021-09-02 14:40:25 | 00:00:00 | 00:00:00 | 00:37:30 | 00:03:20 | 2021-09-02 15:21:15 | {30}
- 8 | 1 | 1 | {} | 8 | 6 | -1 | 1 | {} | 2021-09-02 15:22:05 | 00:00:50 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 15:22:05 | {30}
- 9 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:03:20 | 00:00:00 | 02:34:10 | 03:39:35 | 1970-01-01 00:00:00 | {}
- 10 | 2 | 2 | {} | 1 | 1 | -1 | 1 | {} | 2021-09-02 09:04:35 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:04:35 | {70}
- 11 | 2 | 2 | {} | 2 | 5 | 2 | 1 | {} | 2021-09-02 09:04:35 | 00:00:00 | 00:00:00 | 00:00:10 | 00:00:00 | 2021-09-02 09:04:45 | {70}
- 12 | 2 | 2 | {} | 3 | 2 | 5 | 4 | {} | 2021-09-02 09:06:00 | 00:01:15 | 00:00:00 | 00:04:10 | 00:11:05 | 2021-09-02 09:21:15 | {70}
- 13 | 2 | 2 | {} | 4 | 2 | 3 | 3 | {} | 2021-09-02 09:22:05 | 00:00:50 | 00:00:00 | 00:04:10 | 00:23:20 | 2021-09-02 09:49:35 | {70}
- 14 | 2 | 2 | {} | 5 | 2 | 4 | 3 | {} | 2021-09-02 09:49:35 | 00:00:00 | 00:00:00 | 00:04:10 | 00:09:10 | 2021-09-02 10:02:55 | {70}
- 15 | 2 | 2 | {} | 6 | 6 | -1 | 3 | {} | 2021-09-02 10:02:55 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 10:02:55 | {70}
- 16 | 2 | 2 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:02:05 | 00:00:00 | 00:12:40 | 00:43:35 | 1970-01-01 00:00:00 | {}
- 17 | 3 | 3 | {} | 1 | 1 | -1 | 1 | {} | 2021-09-02 09:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:00:00 | {20}
- 18 | 3 | 3 | {} | 2 | 5 | 3 | 1 | {} | 2021-09-02 09:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:00:00 | {20}
- 19 | 3 | 3 | {} | 3 | 2 | 1 | 1 | {} | 2021-09-02 09:00:00 | 00:00:00 | 00:00:00 | 00:04:10 | 01:00:25 | 2021-09-02 10:04:35 | {20}
- 20 | 3 | 3 | {} | 4 | 3 | 4 | 1 | {} | 2021-09-02 10:04:35 | 00:00:00 | 00:00:00 | 00:37:30 | 00:41:40 | 2021-09-02 11:23:45 | {40}
- 21 | 3 | 3 | {} | 5 | 4 | 4 | 4 | {} | 2021-09-02 11:25:00 | 00:01:15 | 00:00:00 | 00:37:30 | 00:03:45 | 2021-09-02 12:06:15 | {20}
- 22 | 3 | 3 | {} | 6 | 6 | -1 | 1 | {} | 2021-09-02 12:07:30 | 00:01:15 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 12:07:30 | {20}
- 23 | 3 | 3 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:02:30 | 00:00:00 | 01:19:10 | 01:45:50 | 1970-01-01 00:00:00 | {}
- 24 | 4 | 4 | {} | 1 | 1 | -1 | 3 | {} | 2021-09-02 09:04:10 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:04:10 | {0}
- 25 | 4 | 4 | {} | 2 | 5 | 4 | 1 | {} | 2021-09-02 09:04:10 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:04:10 | {0}
- 26 | 4 | 4 | {} | 3 | 3 | 2 | 5 | {} | 2021-09-02 09:04:35 | 00:00:25 | 00:00:00 | 00:37:30 | 00:01:40 | 2021-09-02 09:43:45 | {10}
- 27 | 4 | 4 | {} | 4 | 3 | 1 | 3 | {} | 2021-09-02 09:44:10 | 00:00:25 | 00:00:00 | 00:37:30 | 00:00:00 | 2021-09-02 10:21:40 | {20}
- 28 | 4 | 4 | {} | 5 | 4 | 2 | 6 | {} | 2021-09-02 10:23:10 | 00:01:30 | 00:00:00 | 00:37:30 | 00:00:00 | 2021-09-02 11:00:40 | {10}
- 29 | 4 | 4 | {} | 6 | 4 | 1 | 5 | {} | 2021-09-02 11:02:31 | 00:01:51 | 00:00:00 | 00:37:30 | 04:52:54 | 2021-09-02 16:32:55 | {0}
- 30 | 4 | 4 | {} | 7 | 6 | -1 | 3 | {} | 2021-09-02 16:33:20 | 00:00:25 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 16:33:20 | {0}
- 31 | 4 | 4 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:04:36 | 00:00:00 | 02:30:00 | 04:54:34 | 1970-01-01 00:00:00 | {}
- 32 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:12:31 | 00:00:00 | 06:36:00 | 11:03:34 | 1970-01-01 00:00:00 | {}
-(32 rows)
-
-/* -- q2 */
-SELECT *
-FROM vrp_vroom(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT start_id, end_id, make_interval(secs => duration) AS duration FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------------------+-------------+------------+--------------+--------------+---------------------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 1970-01-01 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 2 | 1 | 1 | {} | 2 | 3 | 100 | 1 | {} | 1970-01-01 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 3 | 1 | 1 | {} | 3 | 2 | 1414 | 2 | {} | 1970-01-01 00:35:04 | 00:35:04 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:35:04 | {}
- 4 | 1 | 1 | {} | 4 | 2 | 1515 | 3 | {} | 1970-01-01 01:12:39 | 00:37:35 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 01:12:39 | {}
- 5 | 1 | 1 | {} | 5 | 4 | 100 | 4 | {} | 1970-01-01 01:31:01 | 00:18:22 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 01:31:01 | {}
- 6 | 1 | 1 | {} | 6 | 6 | -1 | 4 | {} | 1970-01-01 01:31:01 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 01:31:01 | {}
- 7 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 01:31:01 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 8 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 01:31:01 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
-(8 rows)
-
-/* -- q3 */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/vroom/vroomJobs.pg b/docqueries/vroom/vroomJobs.pg
deleted file mode 100644
index 33d5e651b..000000000
--- a/docqueries/vroom/vroomJobs.pg
+++ /dev/null
@@ -1,53 +0,0 @@
-SET TIMEZONE TO 'UTC';
-SELECT (to_timestamp(1630573200) at time zone 'UTC')::TIMESTAMP;
-
-/* -- q0 */
-ALTER TABLE vroom.jobs ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE vroom.shipments ALTER COLUMN p_service TYPE INTERVAL USING make_interval(secs => p_service);
-ALTER TABLE vroom.shipments ALTER COLUMN d_service TYPE INTERVAL USING make_interval(secs => d_service);
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.matrix ALTER COLUMN duration TYPE INTERVAL USING make_interval(secs => duration);
-/* -- q1 */
-SELECT *
-FROM vrp_vroomJobs(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
-/* -- q2 */
-SELECT *
-FROM vrp_vroomJobs(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT start_id, end_id, make_interval(secs => duration) AS duration FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
-/* -- q3 */
diff --git a/docqueries/vroom/vroomJobs.result b/docqueries/vroom/vroomJobs.result
deleted file mode 100644
index f15db83fd..000000000
--- a/docqueries/vroom/vroomJobs.result
+++ /dev/null
@@ -1,105 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-SET TIMEZONE TO 'UTC';
-SET
-SELECT (to_timestamp(1630573200) at time zone 'UTC')::TIMESTAMP;
- timezone
----------------------
- 2021-09-02 09:00:00
-(1 row)
-
-/* -- q0 */
-ALTER TABLE vroom.jobs ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE
-ALTER TABLE vroom.shipments ALTER COLUMN p_service TYPE INTERVAL USING make_interval(secs => p_service);
-ALTER TABLE
-ALTER TABLE vroom.shipments ALTER COLUMN d_service TYPE INTERVAL USING make_interval(secs => d_service);
-ALTER TABLE
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.matrix ALTER COLUMN duration TYPE INTERVAL USING make_interval(secs => duration);
-ALTER TABLE
-/* -- q1 */
-SELECT *
-FROM vrp_vroomJobs(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------------------+-------------+------------+--------------+--------------+---------------------+-------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:05:00 | {20}
- 2 | 1 | 1 | {} | 2 | 5 | 1 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:05:00 | {20}
- 3 | 1 | 1 | {} | 3 | 2 | 1 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:04:10 | 00:55:25 | 2021-09-02 10:04:35 | {20}
- 4 | 1 | 1 | {} | 4 | 6 | -1 | 1 | {} | 2021-09-02 10:04:35 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 10:04:35 | {20}
- 5 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:00:00 | 00:00:00 | 00:04:10 | 00:55:25 | 1970-01-01 00:00:00 | {}
- 6 | 2 | 2 | {} | 1 | 1 | -1 | 1 | {} | 2021-09-02 09:04:35 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:04:35 | {100}
- 7 | 2 | 2 | {} | 2 | 5 | 2 | 1 | {} | 2021-09-02 09:04:35 | 00:00:00 | 00:00:00 | 00:00:10 | 00:00:00 | 2021-09-02 09:04:45 | {100}
- 8 | 2 | 2 | {} | 3 | 2 | 2 | 2 | {} | 2021-09-02 09:05:35 | 00:00:50 | 00:00:00 | 00:04:10 | 00:15:15 | 2021-09-02 09:25:00 | {100}
- 9 | 2 | 2 | {} | 4 | 2 | 5 | 4 | {} | 2021-09-02 09:26:30 | 00:01:30 | 00:00:00 | 00:04:10 | 00:00:00 | 2021-09-02 09:30:40 | {100}
- 10 | 2 | 2 | {} | 5 | 2 | 3 | 3 | {} | 2021-09-02 09:31:30 | 00:00:50 | 00:00:00 | 00:04:10 | 00:13:55 | 2021-09-02 09:49:35 | {100}
- 11 | 2 | 2 | {} | 6 | 2 | 4 | 3 | {} | 2021-09-02 09:49:35 | 00:00:00 | 00:00:00 | 00:04:10 | 00:09:10 | 2021-09-02 10:02:55 | {100}
- 12 | 2 | 2 | {} | 7 | 6 | -1 | 3 | {} | 2021-09-02 10:02:55 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 10:02:55 | {100}
- 13 | 2 | 2 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:03:10 | 00:00:00 | 00:16:50 | 00:38:20 | 1970-01-01 00:00:00 | {}
- 14 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:03:10 | 00:00:00 | 00:21:00 | 01:33:45 | 1970-01-01 00:00:00 | {}
-(14 rows)
-
-/* -- q2 */
-SELECT *
-FROM vrp_vroomJobs(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT start_id, end_id, make_interval(secs => duration) AS duration FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------------------+-------------+------------+--------------+--------------+---------------------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 1970-01-01 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 2 | 1 | 1 | {} | 2 | 2 | 1414 | 2 | {} | 1970-01-01 00:35:04 | 00:35:04 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:35:04 | {}
- 3 | 1 | 1 | {} | 3 | 2 | 1515 | 3 | {} | 1970-01-01 01:12:39 | 00:37:35 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 01:12:39 | {}
- 4 | 1 | 1 | {} | 4 | 6 | -1 | 4 | {} | 1970-01-01 01:31:01 | 00:18:22 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 01:31:01 | {}
- 5 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 01:31:01 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 6 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 01:31:01 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
-(6 rows)
-
-/* -- q3 */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/vroom/vroomJobsPlain.pg b/docqueries/vroom/vroomJobsPlain.pg
deleted file mode 100644
index 45ab67143..000000000
--- a/docqueries/vroom/vroomJobsPlain.pg
+++ /dev/null
@@ -1,36 +0,0 @@
-/* -- q1 */
-SELECT *
-FROM vrp_vroomJobsPlain(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
-/* -- q2 */
-SELECT *
-FROM vrp_vroomJobsPlain(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT * FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
-/* -- q3 */
diff --git a/docqueries/vroom/vroomJobsPlain.result b/docqueries/vroom/vroomJobsPlain.result
deleted file mode 100644
index 17990bf1b..000000000
--- a/docqueries/vroom/vroomJobsPlain.result
+++ /dev/null
@@ -1,70 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- q1 */
-SELECT *
-FROM vrp_vroomJobsPlain(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------+-------------+------------+--------------+--------------+-----------+-------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 300 | 0 | 0 | 0 | 0 | 300 | {20}
- 2 | 1 | 1 | {} | 2 | 5 | 1 | 1 | {} | 300 | 0 | 0 | 0 | 0 | 300 | {20}
- 3 | 1 | 1 | {} | 3 | 2 | 1 | 1 | {} | 300 | 0 | 0 | 250 | 3325 | 3875 | {20}
- 4 | 1 | 1 | {} | 4 | 6 | -1 | 1 | {} | 3875 | 0 | 0 | 0 | 0 | 3875 | {20}
- 5 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 0 | 0 | 0 | 250 | 3325 | 0 | {}
- 6 | 2 | 2 | {} | 1 | 1 | -1 | 1 | {} | 275 | 0 | 0 | 0 | 0 | 275 | {100}
- 7 | 2 | 2 | {} | 2 | 5 | 2 | 1 | {} | 275 | 0 | 0 | 10 | 0 | 285 | {100}
- 8 | 2 | 2 | {} | 3 | 2 | 2 | 2 | {} | 335 | 50 | 0 | 250 | 915 | 1500 | {100}
- 9 | 2 | 2 | {} | 4 | 2 | 5 | 4 | {} | 1590 | 90 | 0 | 250 | 0 | 1840 | {100}
- 10 | 2 | 2 | {} | 5 | 2 | 3 | 3 | {} | 1890 | 50 | 0 | 250 | 835 | 2975 | {100}
- 11 | 2 | 2 | {} | 6 | 2 | 4 | 3 | {} | 2975 | 0 | 0 | 250 | 550 | 3775 | {100}
- 12 | 2 | 2 | {} | 7 | 6 | -1 | 3 | {} | 3775 | 0 | 0 | 0 | 0 | 3775 | {100}
- 13 | 2 | 2 | {} | 0 | 0 | 0 | 0 | {} | 0 | 190 | 0 | 1010 | 2300 | 0 | {}
- 14 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 0 | 190 | 0 | 1260 | 5625 | 0 | {}
-(14 rows)
-
-/* -- q2 */
-SELECT *
-FROM vrp_vroomJobsPlain(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT * FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------+-------------+------------+--------------+--------------+-----------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 0 | 0 | 0 | 0 | 0 | 0 | {}
- 2 | 1 | 1 | {} | 2 | 2 | 1414 | 2 | {} | 2104 | 2104 | 0 | 0 | 0 | 2104 | {}
- 3 | 1 | 1 | {} | 3 | 2 | 1515 | 3 | {} | 4359 | 2255 | 0 | 0 | 0 | 4359 | {}
- 4 | 1 | 1 | {} | 4 | 6 | -1 | 4 | {} | 5461 | 1102 | 0 | 0 | 0 | 5461 | {}
- 5 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 0 | 5461 | 0 | 0 | 0 | 0 | {}
- 6 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 0 | 5461 | 0 | 0 | 0 | 0 | {}
-(6 rows)
-
-/* -- q3 */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/vroom/vroomPlain.pg b/docqueries/vroom/vroomPlain.pg
deleted file mode 100644
index 8dce884c4..000000000
--- a/docqueries/vroom/vroomPlain.pg
+++ /dev/null
@@ -1,44 +0,0 @@
-/* -- q1 */
-SELECT *
-FROM vrp_vroomPlain(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
-/* -- q2 */
-SELECT *
-FROM vrp_vroomPlain(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT * FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
-/* -- q3 */
diff --git a/docqueries/vroom/vroomPlain.result b/docqueries/vroom/vroomPlain.result
deleted file mode 100644
index 0cdf29174..000000000
--- a/docqueries/vroom/vroomPlain.result
+++ /dev/null
@@ -1,98 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- q1 */
-SELECT *
-FROM vrp_vroomPlain(
- 'SELECT * FROM vroom.jobs',
- 'SELECT * FROM vroom.jobs_time_windows',
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------+-------------+------------+--------------+--------------+-----------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 300 | 0 | 0 | 0 | 0 | 300 | {30}
- 2 | 1 | 1 | {} | 2 | 5 | 1 | 1 | {} | 300 | 0 | 0 | 0 | 0 | 300 | {30}
- 3 | 1 | 1 | {} | 3 | 2 | 2 | 2 | {} | 350 | 50 | 0 | 250 | 900 | 1500 | {30}
- 4 | 1 | 1 | {} | 4 | 3 | 5 | 2 | {} | 1500 | 0 | 0 | 2250 | 11850 | 15600 | {40}
- 5 | 1 | 1 | {} | 5 | 3 | 3 | 1 | {} | 15650 | 50 | 0 | 2250 | 0 | 17900 | {60}
- 6 | 1 | 1 | {} | 6 | 4 | 5 | 2 | {} | 17950 | 50 | 0 | 2250 | 225 | 20425 | {50}
- 7 | 1 | 1 | {} | 7 | 4 | 3 | 2 | {} | 20425 | 0 | 0 | 2250 | 200 | 22875 | {30}
- 8 | 1 | 1 | {} | 8 | 6 | -1 | 1 | {} | 22925 | 50 | 0 | 0 | 0 | 22925 | {30}
- 9 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 0 | 200 | 0 | 9250 | 13175 | 0 | {}
- 10 | 2 | 2 | {} | 1 | 1 | -1 | 1 | {} | 275 | 0 | 0 | 0 | 0 | 275 | {70}
- 11 | 2 | 2 | {} | 2 | 5 | 2 | 1 | {} | 275 | 0 | 0 | 10 | 0 | 285 | {70}
- 12 | 2 | 2 | {} | 3 | 2 | 5 | 4 | {} | 360 | 75 | 0 | 250 | 665 | 1275 | {70}
- 13 | 2 | 2 | {} | 4 | 2 | 3 | 3 | {} | 1325 | 50 | 0 | 250 | 1400 | 2975 | {70}
- 14 | 2 | 2 | {} | 5 | 2 | 4 | 3 | {} | 2975 | 0 | 0 | 250 | 550 | 3775 | {70}
- 15 | 2 | 2 | {} | 6 | 6 | -1 | 3 | {} | 3775 | 0 | 0 | 0 | 0 | 3775 | {70}
- 16 | 2 | 2 | {} | 0 | 0 | 0 | 0 | {} | 0 | 125 | 0 | 760 | 2615 | 0 | {}
- 17 | 3 | 3 | {} | 1 | 1 | -1 | 1 | {} | 0 | 0 | 0 | 0 | 0 | 0 | {20}
- 18 | 3 | 3 | {} | 2 | 5 | 3 | 1 | {} | 0 | 0 | 0 | 0 | 0 | 0 | {20}
- 19 | 3 | 3 | {} | 3 | 2 | 1 | 1 | {} | 0 | 0 | 0 | 250 | 3625 | 3875 | {20}
- 20 | 3 | 3 | {} | 4 | 3 | 4 | 1 | {} | 3875 | 0 | 0 | 2250 | 2500 | 8625 | {40}
- 21 | 3 | 3 | {} | 5 | 4 | 4 | 4 | {} | 8700 | 75 | 0 | 2250 | 225 | 11175 | {20}
- 22 | 3 | 3 | {} | 6 | 6 | -1 | 1 | {} | 11250 | 75 | 0 | 0 | 0 | 11250 | {20}
- 23 | 3 | 3 | {} | 0 | 0 | 0 | 0 | {} | 0 | 150 | 0 | 4750 | 6350 | 0 | {}
- 24 | 4 | 4 | {} | 1 | 1 | -1 | 3 | {} | 250 | 0 | 0 | 0 | 0 | 250 | {0}
- 25 | 4 | 4 | {} | 2 | 5 | 4 | 1 | {} | 250 | 0 | 0 | 0 | 0 | 250 | {0}
- 26 | 4 | 4 | {} | 3 | 3 | 2 | 5 | {} | 275 | 25 | 0 | 2250 | 100 | 2625 | {10}
- 27 | 4 | 4 | {} | 4 | 3 | 1 | 3 | {} | 2650 | 25 | 0 | 2250 | 0 | 4900 | {20}
- 28 | 4 | 4 | {} | 5 | 4 | 2 | 6 | {} | 4990 | 90 | 0 | 2250 | 0 | 7240 | {10}
- 29 | 4 | 4 | {} | 6 | 4 | 1 | 5 | {} | 7351 | 111 | 0 | 2250 | 17574 | 27175 | {0}
- 30 | 4 | 4 | {} | 7 | 6 | -1 | 3 | {} | 27200 | 25 | 0 | 0 | 0 | 27200 | {0}
- 31 | 4 | 4 | {} | 0 | 0 | 0 | 0 | {} | 0 | 276 | 0 | 9000 | 17674 | 0 | {}
- 32 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 0 | 751 | 0 | 23760 | 39814 | 0 | {}
-(32 rows)
-
-/* -- q2 */
-SELECT *
-FROM vrp_vroomPlain(
- $jobs$
- SELECT * FROM (
- VALUES (1414, 2), (1515, 3)
- ) AS C(id, location_id)
- $jobs$,
- NULL,
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT * FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------+-------------+------------+--------------+--------------+-----------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 0 | 0 | 0 | 0 | 0 | 0 | {}
- 2 | 1 | 1 | {} | 2 | 3 | 100 | 1 | {} | 0 | 0 | 0 | 0 | 0 | 0 | {}
- 3 | 1 | 1 | {} | 3 | 2 | 1414 | 2 | {} | 2104 | 2104 | 0 | 0 | 0 | 2104 | {}
- 4 | 1 | 1 | {} | 4 | 2 | 1515 | 3 | {} | 4359 | 2255 | 0 | 0 | 0 | 4359 | {}
- 5 | 1 | 1 | {} | 5 | 4 | 100 | 4 | {} | 5461 | 1102 | 0 | 0 | 0 | 5461 | {}
- 6 | 1 | 1 | {} | 6 | 6 | -1 | 4 | {} | 5461 | 0 | 0 | 0 | 0 | 5461 | {}
- 7 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 0 | 5461 | 0 | 0 | 0 | 0 | {}
- 8 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 0 | 5461 | 0 | 0 | 0 | 0 | {}
-(8 rows)
-
-/* -- q3 */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/vroom/vroomShipments.pg b/docqueries/vroom/vroomShipments.pg
deleted file mode 100644
index ec7b6c610..000000000
--- a/docqueries/vroom/vroomShipments.pg
+++ /dev/null
@@ -1,53 +0,0 @@
-SET TIMEZONE TO 'UTC';
-SELECT (to_timestamp(1630573200) at time zone 'UTC')::TIMESTAMP;
-
-/* -- q0 */
-ALTER TABLE vroom.jobs ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE vroom.shipments ALTER COLUMN p_service TYPE INTERVAL USING make_interval(secs => p_service);
-ALTER TABLE vroom.shipments ALTER COLUMN d_service TYPE INTERVAL USING make_interval(secs => d_service);
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE vroom.matrix ALTER COLUMN duration TYPE INTERVAL USING make_interval(secs => duration);
-/* -- q1 */
-SELECT *
-FROM vrp_vroomShipments(
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
-/* -- q2 */
-SELECT *
-FROM vrp_vroomShipments(
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT start_id, end_id, make_interval(secs => duration) AS duration FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
-/* -- q3 */
diff --git a/docqueries/vroom/vroomShipments.result b/docqueries/vroom/vroomShipments.result
deleted file mode 100644
index 3238c847d..000000000
--- a/docqueries/vroom/vroomShipments.result
+++ /dev/null
@@ -1,110 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-SET TIMEZONE TO 'UTC';
-SET
-SELECT (to_timestamp(1630573200) at time zone 'UTC')::TIMESTAMP;
- timezone
----------------------
- 2021-09-02 09:00:00
-(1 row)
-
-/* -- q0 */
-ALTER TABLE vroom.jobs ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE
-ALTER TABLE vroom.shipments ALTER COLUMN p_service TYPE INTERVAL USING make_interval(secs => p_service);
-ALTER TABLE
-ALTER TABLE vroom.shipments ALTER COLUMN d_service TYPE INTERVAL USING make_interval(secs => d_service);
-ALTER TABLE
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.vehicles ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks ALTER COLUMN service TYPE INTERVAL USING make_interval(secs => service);
-ALTER TABLE
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.jobs_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.shipments_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_open TYPE TIMESTAMP USING (to_timestamp(tw_open + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.breaks_time_windows ALTER COLUMN tw_close TYPE TIMESTAMP USING (to_timestamp(tw_close + 1630573200) at time zone 'UTC')::TIMESTAMP;
-ALTER TABLE
-ALTER TABLE vroom.matrix ALTER COLUMN duration TYPE INTERVAL USING make_interval(secs => duration);
-ALTER TABLE
-/* -- q1 */
-SELECT *
-FROM vrp_vroomShipments(
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------------------+-------------+------------+--------------+--------------+---------------------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:05:00 | {0}
- 2 | 1 | 1 | {} | 2 | 5 | 1 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:05:00 | {0}
- 3 | 1 | 1 | {} | 3 | 3 | 4 | 1 | {} | 2021-09-02 09:05:00 | 00:00:00 | 00:00:00 | 00:37:30 | 01:41:15 | 2021-09-02 11:23:45 | {20}
- 4 | 1 | 1 | {} | 4 | 4 | 4 | 4 | {} | 2021-09-02 11:25:00 | 00:01:15 | 00:00:00 | 00:37:30 | 00:03:45 | 2021-09-02 12:06:15 | {0}
- 5 | 1 | 1 | {} | 5 | 3 | 5 | 2 | {} | 2021-09-02 12:07:45 | 00:01:30 | 00:00:00 | 00:37:30 | 00:34:45 | 2021-09-02 13:20:00 | {10}
- 6 | 1 | 1 | {} | 6 | 3 | 3 | 1 | {} | 2021-09-02 13:20:50 | 00:00:50 | 00:00:00 | 00:37:30 | 00:00:00 | 2021-09-02 13:58:20 | {30}
- 7 | 1 | 1 | {} | 7 | 4 | 5 | 2 | {} | 2021-09-02 13:59:10 | 00:00:50 | 00:00:00 | 00:37:30 | 00:03:45 | 2021-09-02 14:40:25 | {20}
- 8 | 1 | 1 | {} | 8 | 4 | 3 | 2 | {} | 2021-09-02 14:40:25 | 00:00:00 | 00:00:00 | 00:37:30 | 00:03:20 | 2021-09-02 15:21:15 | {0}
- 9 | 1 | 1 | {} | 9 | 6 | -1 | 1 | {} | 2021-09-02 15:22:05 | 00:00:50 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 15:22:05 | {0}
- 10 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:05:15 | 00:00:00 | 03:45:00 | 02:26:50 | 1970-01-01 00:00:00 | {}
- 11 | 2 | 4 | {} | 1 | 1 | -1 | 3 | {} | 2021-09-02 09:04:10 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:04:10 | {0}
- 12 | 2 | 4 | {} | 2 | 5 | 4 | 1 | {} | 2021-09-02 09:04:10 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 09:04:10 | {0}
- 13 | 2 | 4 | {} | 3 | 3 | 2 | 5 | {} | 2021-09-02 09:04:35 | 00:00:25 | 00:00:00 | 00:37:30 | 00:01:40 | 2021-09-02 09:43:45 | {10}
- 14 | 2 | 4 | {} | 4 | 3 | 1 | 3 | {} | 2021-09-02 09:44:10 | 00:00:25 | 00:00:00 | 00:37:30 | 00:00:00 | 2021-09-02 10:21:40 | {20}
- 15 | 2 | 4 | {} | 5 | 4 | 2 | 6 | {} | 2021-09-02 10:23:10 | 00:01:30 | 00:00:00 | 00:37:30 | 00:00:00 | 2021-09-02 11:00:40 | {10}
- 16 | 2 | 4 | {} | 6 | 4 | 1 | 5 | {} | 2021-09-02 11:02:31 | 00:01:51 | 00:00:00 | 00:37:30 | 04:52:54 | 2021-09-02 16:32:55 | {0}
- 17 | 2 | 4 | {} | 7 | 6 | -1 | 3 | {} | 2021-09-02 16:33:20 | 00:00:25 | 00:00:00 | 00:00:00 | 00:00:00 | 2021-09-02 16:33:20 | {0}
- 18 | 2 | 4 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:04:36 | 00:00:00 | 02:30:00 | 04:54:34 | 1970-01-01 00:00:00 | {}
- 19 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:09:51 | 00:00:00 | 06:15:00 | 07:21:24 | 1970-01-01 00:00:00 | {}
-(19 rows)
-
-/* -- q2 */
-SELECT *
-FROM vrp_vroomShipments(
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT start_id, end_id, make_interval(secs => duration) AS duration FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------------------+-------------+------------+--------------+--------------+---------------------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 1970-01-01 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 2 | 1 | 1 | {} | 2 | 3 | 100 | 1 | {} | 1970-01-01 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 3 | 1 | 1 | {} | 3 | 4 | 100 | 4 | {} | 1970-01-01 00:21:39 | 00:21:39 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:21:39 | {}
- 4 | 1 | 1 | {} | 4 | 6 | -1 | 4 | {} | 1970-01-01 00:21:39 | 00:00:00 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:21:39 | {}
- 5 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:21:39 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
- 6 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 1970-01-01 00:00:00 | 00:21:39 | 00:00:00 | 00:00:00 | 00:00:00 | 1970-01-01 00:00:00 | {}
-(6 rows)
-
-/* -- q3 */
-ROLLBACK;
-ROLLBACK
diff --git a/docqueries/vroom/vroomShipmentsPlain.pg b/docqueries/vroom/vroomShipmentsPlain.pg
deleted file mode 100644
index 3631bb1f2..000000000
--- a/docqueries/vroom/vroomShipmentsPlain.pg
+++ /dev/null
@@ -1,36 +0,0 @@
-/* -- q1 */
-SELECT *
-FROM vrp_vroomShipmentsPlain(
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
-/* -- q2 */
-SELECT *
-FROM vrp_vroomShipmentsPlain(
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT * FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
-/* -- q3 */
diff --git a/docqueries/vroom/vroomShipmentsPlain.result b/docqueries/vroom/vroomShipmentsPlain.result
deleted file mode 100644
index 1dc6458d8..000000000
--- a/docqueries/vroom/vroomShipmentsPlain.result
+++ /dev/null
@@ -1,75 +0,0 @@
-BEGIN;
-BEGIN
-SET client_min_messages TO NOTICE;
-SET
-/* -- q1 */
-SELECT *
-FROM vrp_vroomShipmentsPlain(
- 'SELECT * FROM vroom.shipments',
- 'SELECT * FROM vroom.shipments_time_windows',
- 'SELECT * FROM vroom.vehicles',
- 'SELECT * FROM vroom.breaks',
- 'SELECT * FROM vroom.breaks_time_windows',
- 'SELECT * FROM vroom.matrix'
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------+-------------+------------+--------------+--------------+-----------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 300 | 0 | 0 | 0 | 0 | 300 | {0}
- 2 | 1 | 1 | {} | 2 | 5 | 1 | 1 | {} | 300 | 0 | 0 | 0 | 0 | 300 | {0}
- 3 | 1 | 1 | {} | 3 | 3 | 4 | 1 | {} | 300 | 0 | 0 | 2250 | 6075 | 8625 | {20}
- 4 | 1 | 1 | {} | 4 | 4 | 4 | 4 | {} | 8700 | 75 | 0 | 2250 | 225 | 11175 | {0}
- 5 | 1 | 1 | {} | 5 | 3 | 5 | 2 | {} | 11265 | 90 | 0 | 2250 | 2085 | 15600 | {10}
- 6 | 1 | 1 | {} | 6 | 3 | 3 | 1 | {} | 15650 | 50 | 0 | 2250 | 0 | 17900 | {30}
- 7 | 1 | 1 | {} | 7 | 4 | 5 | 2 | {} | 17950 | 50 | 0 | 2250 | 225 | 20425 | {20}
- 8 | 1 | 1 | {} | 8 | 4 | 3 | 2 | {} | 20425 | 0 | 0 | 2250 | 200 | 22875 | {0}
- 9 | 1 | 1 | {} | 9 | 6 | -1 | 1 | {} | 22925 | 50 | 0 | 0 | 0 | 22925 | {0}
- 10 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 0 | 315 | 0 | 13500 | 8810 | 0 | {}
- 11 | 2 | 4 | {} | 1 | 1 | -1 | 3 | {} | 250 | 0 | 0 | 0 | 0 | 250 | {0}
- 12 | 2 | 4 | {} | 2 | 5 | 4 | 1 | {} | 250 | 0 | 0 | 0 | 0 | 250 | {0}
- 13 | 2 | 4 | {} | 3 | 3 | 2 | 5 | {} | 275 | 25 | 0 | 2250 | 100 | 2625 | {10}
- 14 | 2 | 4 | {} | 4 | 3 | 1 | 3 | {} | 2650 | 25 | 0 | 2250 | 0 | 4900 | {20}
- 15 | 2 | 4 | {} | 5 | 4 | 2 | 6 | {} | 4990 | 90 | 0 | 2250 | 0 | 7240 | {10}
- 16 | 2 | 4 | {} | 6 | 4 | 1 | 5 | {} | 7351 | 111 | 0 | 2250 | 17574 | 27175 | {0}
- 17 | 2 | 4 | {} | 7 | 6 | -1 | 3 | {} | 27200 | 25 | 0 | 0 | 0 | 27200 | {0}
- 18 | 2 | 4 | {} | 0 | 0 | 0 | 0 | {} | 0 | 276 | 0 | 9000 | 17674 | 0 | {}
- 19 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 0 | 591 | 0 | 22500 | 26484 | 0 | {}
-(19 rows)
-
-/* -- q2 */
-SELECT *
-FROM vrp_vroomShipmentsPlain(
- $shipments$
- SELECT * FROM (
- VALUES (100, 1, 4)
- ) AS C(id, p_location_id, d_location_id)
- $shipments$,
- NULL,
- $vehicles$
- SELECT * FROM (
- VALUES (1, 1, 4)
- ) AS C(id, start_id, end_id)
- $vehicles$,
- NULL,
- NULL,
- $matrix$
- SELECT * FROM (
- VALUES (1, 2, 2104), (1, 3, 197), (1, 4, 1299),
- (2, 1, 2103), (2, 3, 2255), (2, 4, 3152),
- (3, 1, 197), (3, 2, 2256), (3, 4, 1102),
- (4, 1, 1299), (4, 2, 3153), (4, 3, 1102)
- ) AS C(start_id, end_id, duration)
- $matrix$
-);
- seq | vehicle_seq | vehicle_id | vehicle_data | step_seq | step_type | task_id | location_id | task_data | arrival | travel_time | setup_time | service_time | waiting_time | departure | load
------+-------------+------------+--------------+----------+-----------+---------+-------------+-----------+---------+-------------+------------+--------------+--------------+-----------+------
- 1 | 1 | 1 | {} | 1 | 1 | -1 | 1 | {} | 0 | 0 | 0 | 0 | 0 | 0 | {}
- 2 | 1 | 1 | {} | 2 | 3 | 100 | 1 | {} | 0 | 0 | 0 | 0 | 0 | 0 | {}
- 3 | 1 | 1 | {} | 3 | 4 | 100 | 4 | {} | 1299 | 1299 | 0 | 0 | 0 | 1299 | {}
- 4 | 1 | 1 | {} | 4 | 6 | -1 | 4 | {} | 1299 | 0 | 0 | 0 | 0 | 1299 | {}
- 5 | 1 | 1 | {} | 0 | 0 | 0 | 0 | {} | 0 | 1299 | 0 | 0 | 0 | 0 | {}
- 6 | 0 | 0 | {} | 0 | 0 | 0 | 0 | {} | 0 | 1299 | 0 | 0 | 0 | 0 | {}
-(6 rows)
-
-/* -- q3 */
-ROLLBACK;
-ROLLBACK
diff --git a/doxygen/CMakeLists.txt b/doxygen/CMakeLists.txt
index eacc19de0..0ec31c7e1 100644
--- a/doxygen/CMakeLists.txt
+++ b/doxygen/CMakeLists.txt
@@ -1,23 +1,19 @@
-#
-# Based on:
-# https://majewsky.wordpress.com/2010/08/14/tip-of-the-day-cmake-and-doxygen/
-#
+# Main changes
+# developers is build by default unless other wise stated
-option(BUILD_DOXY
- "Set ON|OFF (default=OFF) to build Developers Documentation" ON)
+option(BUILD_DOXY "Set ON|OFF (default=ON) to build Developers Documentation" ON)
if (BUILD_DOXY)
- message(STATUS "Developers documentation.")
find_package(Doxygen ${DOXYGEN_MINIMUM_VERSION})
- if(DOXYGEN_FOUND)
+ if(Doxygen_FOUND)
+ message(STATUS "DOXYGEN_VERSION=${DOXYGEN_VERSION}")
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
- add_custom_target(doxy
- ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+ doxygen_add_docs(doxy ALL USE_STAMP_FILE
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
- COMMENT "Generating API documentation with Doxygen" VERBATIM
- )
- message(".....OK")
+ COMMENT "Generating API documentation with Doxygen"
+ CONFIG_FILE ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+ )
endif()
endif()
diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in
index 5fef661bf..7542ec171 100644
--- a/doxygen/Doxyfile.in
+++ b/doxygen/Doxyfile.in
@@ -1,2600 +1,354 @@
-# Doxyfile 1.9.1
-
-# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project.
-#
-# All text after a double hash (##) is considered a comment and is placed in
-# front of the TAG it is preceding.
-#
-# All text after a single hash (#) is considered a comment and will be ignored.
-# The format is:
-# TAG = value [value, ...]
-# For lists, items can also be appended using:
-# TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (\" \").
+# Doxyfile 1.9.8
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
-
-# This tag specifies the encoding used for all characters in the configuration
-# file that follow. The default is UTF-8 which is also the encoding used for all
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
-# iconv built into libc) for the transcoding. See
-# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
-# The default value is: UTF-8.
-
DOXYFILE_ENCODING = UTF-8
-
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
-# double-quotes, unless you are using Doxywizard) that should identify the
-# project for which the documentation is generated. This name is used in the
-# title of most generated pages and in a few other places.
-# The default value is: My Project.
-
-PROJECT_NAME = "vrpRouting"
-
-# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
-# could be handy for archiving the generated documentation or if some version
-# control system is used.
-
-PROJECT_NUMBER = "@PROJECT_SHORT_VERSION@"
-
-# Using the PROJECT_BRIEF tag one can provide an optional one line description
-# for a project that appears at the top of each page and should give viewer a
-# quick idea about the purpose of the project. Keep the description short.
-
-PROJECT_BRIEF = "@PROJECT_BRIEF@"
-
-# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
-# in the documentation. The maximum height of the logo should not exceed 55
-# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
-# the logo to the output directory.
-
-PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/../doc/_static/images/vrprouting-logo.png
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
-# into which the generated documentation will be written. If a relative path is
-# entered, it will be relative to the location where doxygen was started. If
-# left blank the current directory will be used.
-
+PROJECT_NAME = @PROJECT_NAME@
+PROJECT_NUMBER = @PROJECT_SHORT_VERSION@
+PROJECT_BRIEF = @PROJECT_BRIEF@
+PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/../doc/_static/images/pgrouting-logo.png
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
-
-# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
-# directories (in 2 levels) under the output directory of each output format and
-# will distribute the generated files over these directories. Enabling this
-# option can be useful when feeding doxygen a huge amount of source files, where
-# putting all generated files in the same directory would otherwise causes
-# performance problems for the file system.
-# The default value is: NO.
-
CREATE_SUBDIRS = NO
-
-# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
-# characters to appear in the names of generated files. If set to NO, non-ASCII
-# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
-# U+3044.
-# The default value is: NO.
-
+CREATE_SUBDIRS_LEVEL = 8
ALLOW_UNICODE_NAMES = NO
-
-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all constant output in the proper language.
-# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
-# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
-# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
-# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
-# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
-# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
-# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
-# Ukrainian and Vietnamese.
-# The default value is: English.
-
OUTPUT_LANGUAGE = English
-
-# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all generated output in the proper direction.
-# Possible values are: None, LTR, RTL and Context.
-# The default value is: None.
-
-OUTPUT_TEXT_DIRECTION = None
-
-# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
-# descriptions after the members that are listed in the file and class
-# documentation (similar to Javadoc). Set to NO to disable this.
-# The default value is: YES.
-
BRIEF_MEMBER_DESC = YES
-
-# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
-# description of a member or function before the detailed description
-#
-# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
-# brief descriptions will be completely suppressed.
-# The default value is: YES.
-
REPEAT_BRIEF = YES
-
-# This tag implements a quasi-intelligent brief description abbreviator that is
-# used to form the text in various listings. Each string in this list, if found
-# as the leading text of the brief description, will be stripped from the text
-# and the result, after processing the whole list, is used as the annotated
-# text. Otherwise, the brief description is used as-is. If left blank, the
-# following values are used ($name is automatically replaced with the name of
-# the entity):The $name class, The $name widget, The $name file, is, provides,
-# specifies, contains, represents, a, an and the.
-
ABBREVIATE_BRIEF =
-
-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
-# doxygen will generate a detailed section even if there is only a brief
-# description.
-# The default value is: NO.
-
ALWAYS_DETAILED_SEC = YES
-
-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
-# inherited members of a class in the documentation of that class as if those
-# members were ordinary class members. Constructors, destructors and assignment
-# operators of the base classes will not be shown.
-# The default value is: NO.
-
INLINE_INHERITED_MEMB = YES
-
-# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
-# before files name in the file list and in the header files. If set to NO the
-# shortest path that makes the file name unique will be used
-# The default value is: YES.
-
FULL_PATH_NAMES = NO
-
-# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
-# Stripping is only done if one of the specified strings matches the left-hand
-# part of the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the path to
-# strip.
-#
-# Note that you can specify absolute paths here, but also relative paths, which
-# will be relative from the directory where doxygen is started.
-# This tag requires that the tag FULL_PATH_NAMES is set to YES.
-
STRIP_FROM_PATH =
-
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
-# path mentioned in the documentation of a class, which tells the reader which
-# header file to include in order to use a class. If left blank only the name of
-# the header file containing the class definition is used. Otherwise one should
-# specify the list of include paths that are normally passed to the compiler
-# using the -I flag.
-
STRIP_FROM_INC_PATH =
-
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
-# less readable) file names. This can be useful is your file systems doesn't
-# support long names like on DOS, Mac, or CD-ROM.
-# The default value is: NO.
-
SHORT_NAMES = NO
-
-# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
-# first line (until the first dot) of a Javadoc-style comment as the brief
-# description. If set to NO, the Javadoc-style will behave just like regular Qt-
-# style comments (thus requiring an explicit @brief command for a brief
-# description.)
-# The default value is: NO.
-
-JAVADOC_AUTOBRIEF = NO
-
-# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
-# such as
-# /***************
-# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
-# Javadoc-style will behave just like regular comments and it will not be
-# interpreted by doxygen.
-# The default value is: NO.
-
+JAVADOC_AUTOBRIEF = YES
JAVADOC_BANNER = NO
-
-# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
-# line (until the first dot) of a Qt-style comment as the brief description. If
-# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
-# requiring an explicit \brief command for a brief description.)
-# The default value is: NO.
-
-QT_AUTOBRIEF = NO
-
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
-# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
-# a brief description. This used to be the default behavior. The new default is
-# to treat a multi-line C++ comment block as a detailed description. Set this
-# tag to YES if you prefer the old behavior instead.
-#
-# Note that setting this tag to YES also means that rational rose comments are
-# not recognized any more.
-# The default value is: NO.
-
+QT_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
-
-# By default Python docstrings are displayed as preformatted text and doxygen's
-# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
-# doxygen's special commands can be used and the contents of the docstring
-# documentation blocks is shown as doxygen documentation.
-# The default value is: YES.
-
-PYTHON_DOCSTRING = YES
-
-# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
-# documentation from any documented member that it re-implements.
-# The default value is: YES.
-
+PYTHON_DOCSTRING =
INHERIT_DOCS = YES
-
-# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
-# page for each member. If set to NO, the documentation of a member will be part
-# of the file/class/namespace that contains it.
-# The default value is: NO.
-
SEPARATE_MEMBER_PAGES = NO
-
-# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
-# uses this value to replace tabs by spaces in code fragments.
-# Minimum value: 1, maximum value: 16, default value: 4.
-
TAB_SIZE = 4
-
-# This tag can be used to specify a number of aliases that act as commands in
-# the documentation. An alias has the form:
-# name=value
-# For example adding
-# "sideeffect=@par Side Effects:\n"
-# will allow you to put the command \sideeffect (or @sideeffect) in the
-# documentation, which will result in a user-defined paragraph with heading
-# "Side Effects:". You can put \n's in the value part of an alias to insert
-# newlines (in the resulting output). You can put ^^ in the value part of an
-# alias to insert a newline as if a physical newline was in the original file.
-# When you need a literal { or } or , in the value part of an alias you have to
-# escape them by means of a backslash (\), this can lead to conflicts with the
-# commands \{ and \} for these it is advised to use the version @{ and @} or use
-# a double escape (\\{ and \\})
-
ALIASES =
-
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
-# only. Doxygen will then generate output that is more tailored for C. For
-# instance, some of the names that are used will be different. The list of all
-# members will be omitted, etc.
-# The default value is: NO.
-
OPTIMIZE_OUTPUT_FOR_C = NO
-
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
-# Python sources only. Doxygen will then generate output that is more tailored
-# for that language. For instance, namespaces will be presented as packages,
-# qualified scopes will look different, etc.
-# The default value is: NO.
-
OPTIMIZE_OUTPUT_JAVA = NO
-
-# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
-# sources. Doxygen will then generate output that is tailored for Fortran.
-# The default value is: NO.
-
OPTIMIZE_FOR_FORTRAN = NO
-
-# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
-# sources. Doxygen will then generate output that is tailored for VHDL.
-# The default value is: NO.
-
OPTIMIZE_OUTPUT_VHDL = NO
-
-# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
-# sources only. Doxygen will then generate output that is more tailored for that
-# language. For instance, namespaces will be presented as modules, types will be
-# separated into more groups, etc.
-# The default value is: NO.
-
OPTIMIZE_OUTPUT_SLICE = NO
-
-# Doxygen selects the parser to use depending on the extension of the files it
-# parses. With this tag you can assign which parser to use for a given
-# extension. Doxygen has a built-in mapping, but you can override or extend it
-# using this tag. The format is ext=language, where ext is a file extension, and
-# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
-# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
-# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
-# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
-# tries to guess whether the code is fixed or free formatted code, this is the
-# default for Fortran type files). For instance to make doxygen treat .inc files
-# as Fortran files (default is PHP), and .f files as C (default is Fortran),
-# use: inc=Fortran f=C.
-#
-# Note: For files without extension you can use no_extension as a placeholder.
-#
-# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
-# the files are not read by doxygen. When specifying no_extension you should add
-# * to the FILE_PATTERNS.
-#
-# Note see also the list of default file extension mappings.
-
EXTENSION_MAPPING =
-
-# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
-# according to the Markdown format, which allows for more readable
-# documentation. See https://daringfireball.net/projects/markdown/ for details.
-# The output of markdown processing is further processed by doxygen, so you can
-# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
-# case of backward compatibilities issues.
-# The default value is: YES.
-
MARKDOWN_SUPPORT = YES
-
-# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
-# to that level are automatically included in the table of contents, even if
-# they do not have an id attribute.
-# Note: This feature currently applies only to Markdown headings.
-# Minimum value: 0, maximum value: 99, default value: 5.
-# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
-
TOC_INCLUDE_HEADINGS = 5
-
-# When enabled doxygen tries to link words that correspond to documented
-# classes, or namespaces to their corresponding documentation. Such a link can
-# be prevented in individual cases by putting a % sign in front of the word or
-# globally by setting AUTOLINK_SUPPORT to NO.
-# The default value is: YES.
-
+MARKDOWN_ID_STYLE = DOXYGEN
AUTOLINK_SUPPORT = YES
-
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
-# to include (a tag file for) the STL sources as input, then you should set this
-# tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string);
-# versus func(std::string) {}). This also make the inheritance and collaboration
-# diagrams that involve STL classes more complete and accurate.
-# The default value is: NO.
-
BUILTIN_STL_SUPPORT = YES
-
-# If you use Microsoft's C++/CLI language, you should set this option to YES to
-# enable parsing support.
-# The default value is: NO.
-
CPP_CLI_SUPPORT = NO
-
-# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
-# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
-# will parse them like normal C++ but will assume all classes use public instead
-# of private inheritance when no explicit protection keyword is present.
-# The default value is: NO.
-
SIP_SUPPORT = NO
-
-# For Microsoft's IDL there are propget and propput attributes to indicate
-# getter and setter methods for a property. Setting this option to YES will make
-# doxygen to replace the get and set methods by a property in the documentation.
-# This will only work if the methods are indeed getting or setting a simple
-# type. If this is not the case, or you want to show the methods anyway, you
-# should set this option to NO.
-# The default value is: YES.
-
IDL_PROPERTY_SUPPORT = YES
-
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES then doxygen will reuse the documentation of the first
-# member in the group (if any) for the other members of the group. By default
-# all members of a group must be documented explicitly.
-# The default value is: NO.
-
DISTRIBUTE_GROUP_DOC = NO
-
-# If one adds a struct or class to a group and this option is enabled, then also
-# any nested class or struct is added to the same group. By default this option
-# is disabled and one has to add nested compounds explicitly via \ingroup.
-# The default value is: NO.
-
GROUP_NESTED_COMPOUNDS = NO
-
-# Set the SUBGROUPING tag to YES to allow class member groups of the same type
-# (for instance a group of public functions) to be put as a subgroup of that
-# type (e.g. under the Public Functions section). Set it to NO to prevent
-# subgrouping. Alternatively, this can be done per class using the
-# \nosubgrouping command.
-# The default value is: YES.
-
SUBGROUPING = YES
-
-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
-# are shown inside the group in which they are included (e.g. using \ingroup)
-# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
-# and RTF).
-#
-# Note that this feature does not work in combination with
-# SEPARATE_MEMBER_PAGES.
-# The default value is: NO.
-
INLINE_GROUPED_CLASSES = NO
-
-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
-# with only public data fields or simple typedef fields will be shown inline in
-# the documentation of the scope in which they are defined (i.e. file,
-# namespace, or group documentation), provided this scope is documented. If set
-# to NO, structs, classes, and unions are shown on a separate page (for HTML and
-# Man pages) or section (for LaTeX and RTF).
-# The default value is: NO.
-
INLINE_SIMPLE_STRUCTS = NO
-
-# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
-# enum is documented as struct, union, or enum with the name of the typedef. So
-# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
-# with name TypeT. When disabled the typedef will appear as a member of a file,
-# namespace, or class. And the struct will be named TypeS. This can typically be
-# useful for C code in case the coding convention dictates that all compound
-# types are typedef'ed and only the typedef is referenced, never the tag name.
-# The default value is: NO.
-
TYPEDEF_HIDES_STRUCT = NO
-
-# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
-# cache is used to resolve symbols given their name and scope. Since this can be
-# an expensive process and often the same symbol appears multiple times in the
-# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
-# doxygen will become slower. If the cache is too large, memory is wasted. The
-# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
-# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
-# symbols. At the end of a run doxygen will report the cache usage and suggest
-# the optimal cache size from a speed point of view.
-# Minimum value: 0, maximum value: 9, default value: 0.
-
LOOKUP_CACHE_SIZE = 0
-
-# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
-# during processing. When set to 0 doxygen will based this on the number of
-# cores available in the system. You can set it explicitly to a value larger
-# than 0 to get more control over the balance between CPU load and processing
-# speed. At this moment only the input processing can be done using multiple
-# threads. Since this is still an experimental feature the default is set to 1,
-# which efficively disables parallel processing. Please report any issues you
-# encounter. Generating dot graphs in parallel is controlled by the
-# DOT_NUM_THREADS setting.
-# Minimum value: 0, maximum value: 32, default value: 1.
-
-NUM_PROC_THREADS = 2
-
+NUM_PROC_THREADS = 1
+TIMESTAMP = NO
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
-
-# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
-# documentation are documented, even if no documentation was available. Private
-# class members and static file members will be hidden unless the
-# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
-# Note: This will also disable the warnings about undocumented members that are
-# normally produced when WARNINGS is set to YES.
-# The default value is: NO.
-
EXTRACT_ALL = YES
-
-# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
-# be included in the documentation.
-# The default value is: NO.
-
EXTRACT_PRIVATE = YES
-
-# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
-# scope will be included in the documentation.
-# The default value is: NO.
-
+EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PACKAGE = YES
-
-# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
-# included in the documentation.
-# The default value is: NO.
-
EXTRACT_STATIC = YES
-
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
-# locally in source files will be included in the documentation. If set to NO,
-# only classes defined in header files are included. Does not have any effect
-# for Java sources.
-# The default value is: YES.
-
EXTRACT_LOCAL_CLASSES = YES
-
-# This flag is only useful for Objective-C code. If set to YES, local methods,
-# which are defined in the implementation section but not in the interface are
-# included in the documentation. If set to NO, only methods in the interface are
-# included.
-# The default value is: NO.
-
EXTRACT_LOCAL_METHODS = NO
-
-# If this flag is set to YES, the members of anonymous namespaces will be
-# extracted and appear in the documentation as a namespace called
-# 'anonymous_namespace{file}', where file will be replaced with the base name of
-# the file that contains the anonymous namespace. By default anonymous namespace
-# are hidden.
-# The default value is: NO.
-
-EXTRACT_ANON_NSPACES = NO
-
-# If this flag is set to YES, the name of an unnamed parameter in a declaration
-# will be determined by the corresponding definition. By default unnamed
-# parameters remain unnamed in the output.
-# The default value is: YES.
-
+EXTRACT_ANON_NSPACES = YES
RESOLVE_UNNAMED_PARAMS = YES
-
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
-# undocumented members inside documented classes or files. If set to NO these
-# members will be included in the various overviews, but no documentation
-# section is generated. This option has no effect if EXTRACT_ALL is enabled.
-# The default value is: NO.
-
HIDE_UNDOC_MEMBERS = NO
-
-# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
-# undocumented classes that are normally visible in the class hierarchy. If set
-# to NO, these classes will be included in the various overviews. This option
-# has no effect if EXTRACT_ALL is enabled.
-# The default value is: NO.
-
HIDE_UNDOC_CLASSES = NO
-
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
-# declarations. If set to NO, these declarations will be included in the
-# documentation.
-# The default value is: NO.
-
HIDE_FRIEND_COMPOUNDS = NO
-
-# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
-# documentation blocks found inside the body of a function. If set to NO, these
-# blocks will be appended to the function's detailed documentation block.
-# The default value is: NO.
-
HIDE_IN_BODY_DOCS = NO
-
-# The INTERNAL_DOCS tag determines if documentation that is typed after a
-# \internal command is included. If the tag is set to NO then the documentation
-# will be excluded. Set it to YES to include the internal documentation.
-# The default value is: NO.
-
INTERNAL_DOCS = NO
-
-# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
-# able to match the capabilities of the underlying filesystem. In case the
-# filesystem is case sensitive (i.e. it supports files in the same directory
-# whose names only differ in casing), the option must be set to YES to properly
-# deal with such files in case they appear in the input. For filesystems that
-# are not case sensitive the option should be be set to NO to properly deal with
-# output files written for symbols that only differ in casing, such as for two
-# classes, one named CLASS and the other named Class, and to also support
-# references to files without having to specify the exact matching casing. On
-# Windows (including Cygwin) and MacOS, users should typically set this option
-# to NO, whereas on Linux or other Unix flavors it should typically be set to
-# YES.
-# The default value is: system dependent.
-
CASE_SENSE_NAMES = YES
-
-# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
-# their full class and namespace scopes in the documentation. If set to YES, the
-# scope will be hidden.
-# The default value is: NO.
-
HIDE_SCOPE_NAMES = NO
-
-# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
-# append additional text to a page's title, such as Class Reference. If set to
-# YES the compound reference will be hidden.
-# The default value is: NO.
-
HIDE_COMPOUND_REFERENCE= NO
-
-# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
-# the files that are included by a file in the documentation of that file.
-# The default value is: YES.
-
+SHOW_HEADERFILE = YES
SHOW_INCLUDE_FILES = YES
-
-# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
-# grouped member an include statement to the documentation, telling the reader
-# which file to include in order to use the member.
-# The default value is: NO.
-
SHOW_GROUPED_MEMB_INC = YES
-
-# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
-# files with double quotes in the documentation rather than with sharp brackets.
-# The default value is: NO.
-
FORCE_LOCAL_INCLUDES = YES
-
-# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
-# documentation for inline members.
-# The default value is: YES.
-
INLINE_INFO = YES
-
-# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
-# (detailed) documentation of file and class members alphabetically by member
-# name. If set to NO, the members will appear in declaration order.
-# The default value is: YES.
-
SORT_MEMBER_DOCS = YES
-
-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
-# descriptions of file, namespace and class members alphabetically by member
-# name. If set to NO, the members will appear in declaration order. Note that
-# this will also influence the order of the classes in the class list.
-# The default value is: NO.
-
SORT_BRIEF_DOCS = YES
-
-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
-# (brief and detailed) documentation of class members so that constructors and
-# destructors are listed first. If set to NO the constructors will appear in the
-# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
-# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
-# member documentation.
-# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
-# detailed member documentation.
-# The default value is: NO.
-
SORT_MEMBERS_CTORS_1ST = YES
-
-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
-# of group names into alphabetical order. If set to NO the group names will
-# appear in their defined order.
-# The default value is: NO.
-
SORT_GROUP_NAMES = NO
-
-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
-# fully-qualified names, including namespaces. If set to NO, the class list will
-# be sorted only by class name, not including the namespace part.
-# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
-# Note: This option applies only to the class list, not to the alphabetical
-# list.
-# The default value is: NO.
-
SORT_BY_SCOPE_NAME = YES
-
-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
-# type resolution of all parameters of a function it will reject a match between
-# the prototype and the implementation of a member function even if there is
-# only one candidate or it is obvious which candidate to choose by doing a
-# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
-# accept a match between prototype and implementation in such cases.
-# The default value is: NO.
-
STRICT_PROTO_MATCHING = YES
-
-# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
-# list. This list is created by putting \todo commands in the documentation.
-# The default value is: YES.
-
GENERATE_TODOLIST = YES
-
-# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
-# list. This list is created by putting \test commands in the documentation.
-# The default value is: YES.
-
GENERATE_TESTLIST = YES
-
-# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
-# list. This list is created by putting \bug commands in the documentation.
-# The default value is: YES.
-
GENERATE_BUGLIST = YES
-
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
-# the deprecated list. This list is created by putting \deprecated commands in
-# the documentation.
-# The default value is: YES.
-
GENERATE_DEPRECATEDLIST= YES
-
-# The ENABLED_SECTIONS tag can be used to enable conditional documentation
-# sections, marked by \if ... \endif and \cond
-# ... \endcond blocks.
-
ENABLED_SECTIONS =
-
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
-# initial value of a variable or macro / define can have for it to appear in the
-# documentation. If the initializer consists of more lines than specified here
-# it will be hidden. Use a value of 0 to hide initializers completely. The
-# appearance of the value of individual variables and macros / defines can be
-# controlled using \showinitializer or \hideinitializer command in the
-# documentation regardless of this setting.
-# Minimum value: 0, maximum value: 10000, default value: 30.
-
MAX_INITIALIZER_LINES = 30
-
-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
-# the bottom of the documentation of classes and structs. If set to YES, the
-# list will mention the files that were used to generate the documentation.
-# The default value is: YES.
-
SHOW_USED_FILES = YES
-
-# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
-# will remove the Files entry from the Quick Index and from the Folder Tree View
-# (if specified).
-# The default value is: YES.
-
SHOW_FILES = YES
-
-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
-# page. This will remove the Namespaces entry from the Quick Index and from the
-# Folder Tree View (if specified).
-# The default value is: YES.
-
SHOW_NAMESPACES = YES
-
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
-# doxygen should invoke to get the current version for each file (typically from
-# the version control system). Doxygen will invoke the program by executing (via
-# popen()) the command command input-file, where command is the value of the
-# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
-# by doxygen. Whatever the program writes to standard output is used as the file
-# version. For an example see the documentation.
-
+HIDE_UNDOC_NAMESPACES = YES
FILE_VERSION_FILTER =
-
-# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
-# by doxygen. The layout file controls the global structure of the generated
-# output files in an output format independent way. To create the layout file
-# that represents doxygen's defaults, run doxygen with the -l option. You can
-# optionally specify a file name after the option, if omitted DoxygenLayout.xml
-# will be used as the name of the layout file.
-#
-# Note that if you run doxygen from a directory containing a file called
-# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
-# tag is left empty.
-
LAYOUT_FILE =
-
-# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
-# the reference definitions. This must be a list of .bib files. The .bib
-# extension is automatically appended if omitted. This requires the bibtex tool
-# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
-# For LaTeX the style of the bibliography can be controlled using
-# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
-# search path. See also \cite for info how to create references.
-
CITE_BIB_FILES =
-
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
-
-# The QUIET tag can be used to turn on/off the messages that are generated to
-# standard output by doxygen. If QUIET is set to YES this implies that the
-# messages are off.
-# The default value is: NO.
-
QUIET = YES
-
-# The WARNINGS tag can be used to turn on/off the warning messages that are
-# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
-# this implies that the warnings are on.
-#
-# Tip: Turn warnings on while writing the documentation.
-# The default value is: YES.
-
WARNINGS = YES
-
-# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
-# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
-# will automatically be disabled.
-# The default value is: YES.
-
WARN_IF_UNDOCUMENTED = YES
-
-# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as not documenting some parameters
-# in a documented function, or documenting parameters that don't exist or using
-# markup commands wrongly.
-# The default value is: YES.
-
WARN_IF_DOC_ERROR = YES
-
-# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
-# are documented, but have no documentation for their parameters or return
-# value. If set to NO, doxygen will only warn about wrong or incomplete
-# parameter documentation, but not about the absence of documentation. If
-# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
-# The default value is: NO.
-
+WARN_IF_INCOMPLETE_DOC = YES
WARN_NO_PARAMDOC = YES
-
-# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
-# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
-# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
-# at the end of the doxygen process doxygen will return with a non-zero status.
-# Possible values are: NO, YES and FAIL_ON_WARNINGS.
-# The default value is: NO.
-
-WARN_AS_ERROR = FAIL_ON_WARNINGS
-
-# The WARN_FORMAT tag determines the format of the warning messages that doxygen
-# can produce. The string should contain the $file, $line, and $text tags, which
-# will be replaced by the file and line number from which the warning originated
-# and the warning text. Optionally the format may contain $version, which will
-# be replaced by the version of the file (if it could be obtained via
-# FILE_VERSION_FILTER)
-# The default value is: $file:$line: $text.
-
+WARN_IF_UNDOC_ENUM_VAL = NO
+WARN_AS_ERROR = NO
WARN_FORMAT = "$file:$line: $text"
-
-# The WARN_LOGFILE tag can be used to specify a file to which warning and error
-# messages should be written. If left blank the output is written to standard
-# error (stderr).
-
-WARN_LOGFILE = @CMAKE_CURRENT_BINARY_DIR@/LOG
-
+WARN_LINE_FORMAT = "at line $line of file $file."
+WARN_LOGFILE = ../DOXYLOG
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
-
-# The INPUT tag is used to specify the files and/or directories that contain
-# documented source files. You may enter file names like myfile.cpp or
-# directories like /usr/src/myproject. Separate the files or directories with
-# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
-# Note: If this tag is empty the current directory is searched.
-
-INPUT = @CMAKE_SOURCE_DIR@/src @CMAKE_SOURCE_DIR@/include @CMAKE_CURRENT_SOURCE_DIR@
-
-# This tag can be used to specify the character encoding of the source files
-# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
-# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
-# documentation (see:
-# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
-# The default value is: UTF-8.
-
+INPUT = @CMAKE_SOURCE_DIR@/src \
+ @CMAKE_SOURCE_DIR@/include \
+ @CMAKE_SOURCE_DIR@/README.md
INPUT_ENCODING = UTF-8
-
-# If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
-# *.h) to filter out the source-files in the directories.
-#
-# Note that for custom extensions or not directly supported extensions you also
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
-# read by doxygen.
-#
-# Note the list of default checked file patterns might differ from the list of
-# default file extension mappings.
-#
-# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
-# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
-# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
-# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
-# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
-# *.ucf, *.qsf and *.ice.
-
-FILE_PATTERNS = *.c *.h \
- *.cpp *.hpp \
- *.dox
-
-# The RECURSIVE tag can be used to specify whether or not subdirectories should
-# be searched for input files as well.
-# The default value is: NO.
-
+INPUT_FILE_ENCODING =
+FILE_PATTERNS =
RECURSIVE = YES
-
-# The EXCLUDE tag can be used to specify files and/or directories that should be
-# excluded from the INPUT source files. This way you can easily exclude a
-# subdirectory from a directory tree whose root is specified with the INPUT tag.
-#
-# Note that relative paths are relative to the directory from which doxygen is
-# run.
-
EXCLUDE =
-
-# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
-# directories that are symbolic links (a Unix file system feature) are excluded
-# from the input.
-# The default value is: NO.
-
EXCLUDE_SYMLINKS = NO
-
-# If the value of the INPUT tag contains directories, you can use the
-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
-# certain files from those directories.
-#
-# Note that the wildcards are matched against the file with absolute path, so to
-# exclude all test directories for example use the pattern */test/*
-
EXCLUDE_PATTERNS =
-
-# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
-# (namespaces, classes, functions, etc.) that should be excluded from the
-# output. The symbol name can be a fully qualified name, a word, or if the
-# wildcard * is used, a substring. Examples: ANamespace, AClass,
-# AClass::ANamespace, ANamespace::*Test
-#
-# Note that the wildcards are matched against the file with absolute path, so to
-# exclude all test directories use the pattern */test/*
-
EXCLUDE_SYMBOLS =
-
-# The EXAMPLE_PATH tag can be used to specify one or more files or directories
-# that contain example code fragments that are included (see the \include
-# command).
-
-EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_SOURCE_DIR@/sql
-
-# If the value of the EXAMPLE_PATH tag contains directories, you can use the
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
-# *.h) to filter out the source-files in the directories. If left blank all
-# files are included.
-
+EXAMPLE_PATH =
EXAMPLE_PATTERNS =
-
-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
-# searched for input files to be used with the \include or \dontinclude commands
-# irrespective of the value of the RECURSIVE tag.
-# The default value is: NO.
-
EXAMPLE_RECURSIVE = NO
-
-# The IMAGE_PATH tag can be used to specify one or more files or directories
-# that contain images that are to be included in the documentation (see the
-# \image command).
-
-IMAGE_PATH = @CMAKE_SOURCE_DIR@/doc/_static/images/developers
-
-# The INPUT_FILTER tag can be used to specify a program that doxygen should
-# invoke to filter for each input file. Doxygen will invoke the filter program
-# by executing (via popen()) the command:
-#
-#
-#
-# where is the value of the INPUT_FILTER tag, and is the
-# name of an input file. Doxygen will then use the output that the filter
-# program writes to standard output. If FILTER_PATTERNS is specified, this tag
-# will be ignored.
-#
-# Note that the filter must not add or remove lines; it is applied before the
-# code is scanned, but not when the output code is generated. If lines are added
-# or removed, the anchors will not be placed correctly.
-#
-# Note that for custom extensions or not directly supported extensions you also
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
-# properly processed by doxygen.
-
+IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/../doc/_static/images/developers \
+ @CMAKE_CURRENT_SOURCE_DIR@/../doc/contraction/images
INPUT_FILTER =
-
-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
-# basis. Doxygen will compare the file name with each pattern and apply the
-# filter if there is a match. The filters are a list of the form: pattern=filter
-# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
-# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
-# patterns match the file name, INPUT_FILTER is applied.
-#
-# Note that for custom extensions or not directly supported extensions you also
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
-# properly processed by doxygen.
-
FILTER_PATTERNS =
-
-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
-# INPUT_FILTER) will also be used to filter the input files that are used for
-# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
-# The default value is: NO.
-
FILTER_SOURCE_FILES = NO
-
-# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
-# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
-# it is also possible to disable source filtering for a specific pattern using
-# *.ext= (so without naming a filter).
-# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
-
FILTER_SOURCE_PATTERNS =
-
-# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
-# is part of the input, its contents will be placed on the main page
-# (index.html). This can be useful if you have a project on for instance GitHub
-# and want to reuse the introduction page also for the doxygen output.
-
-USE_MDFILE_AS_MAINPAGE =
-
+USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/../README.md
+FORTRAN_COMMENT_AFTER = 72
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
-
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
-# generated. Documented entities will be cross-referenced with these sources.
-#
-# Note: To get rid of all source code in the generated output, make sure that
-# also VERBATIM_HEADERS is set to NO.
-# The default value is: NO.
-
SOURCE_BROWSER = YES
-
-# Setting the INLINE_SOURCES tag to YES will include the body of functions,
-# classes and enums directly into the documentation.
-# The default value is: NO.
-
INLINE_SOURCES = YES
-
-# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
-# special comment blocks from generated source code fragments. Normal C, C++ and
-# Fortran comments will always remain visible.
-# The default value is: YES.
-
STRIP_CODE_COMMENTS = YES
-
-# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
-# entity all documented functions referencing it will be listed.
-# The default value is: NO.
-
REFERENCED_BY_RELATION = YES
-
-# If the REFERENCES_RELATION tag is set to YES then for each documented function
-# all documented entities called/used by that function will be listed.
-# The default value is: NO.
-
REFERENCES_RELATION = YES
-
-# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
-# to YES then the hyperlinks from functions in REFERENCES_RELATION and
-# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
-# link to the documentation.
-# The default value is: YES.
-
REFERENCES_LINK_SOURCE = YES
-
-# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
-# source code will show a tooltip with additional information such as prototype,
-# brief description and links to the definition and documentation. Since this
-# will make the HTML file larger and loading of large files a bit slower, you
-# can opt to disable this feature.
-# The default value is: YES.
-# This tag requires that the tag SOURCE_BROWSER is set to YES.
-
SOURCE_TOOLTIPS = YES
-
-# If the USE_HTAGS tag is set to YES then the references to source code will
-# point to the HTML generated by the htags(1) tool instead of doxygen built-in
-# source browser. The htags tool is part of GNU's global source tagging system
-# (see https://www.gnu.org/software/global/global.html). You will need version
-# 4.8.6 or higher.
-#
-# To use it do the following:
-# - Install the latest version of global
-# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
-# - Make sure the INPUT points to the root of the source tree
-# - Run doxygen as normal
-#
-# Doxygen will invoke htags (and that will in turn invoke gtags), so these
-# tools must be available from the command line (i.e. in the search path).
-#
-# The result: instead of the source browser generated by doxygen, the links to
-# source code will now point to the output of htags.
-# The default value is: NO.
-# This tag requires that the tag SOURCE_BROWSER is set to YES.
-
USE_HTAGS = NO
-
-# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
-# verbatim copy of the header file for each class for which an include is
-# specified. Set to NO to disable this.
-# See also: Section \class.
-# The default value is: YES.
-
VERBATIM_HEADERS = YES
-
-# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
-# clang parser (see:
-# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
-# performance. This can be particularly helpful with template rich C++ code for
-# which doxygen's built-in parser lacks the necessary type information.
-# Note: The availability of this option depends on whether or not doxygen was
-# generated with the -Duse_libclang=ON option for CMake.
-# The default value is: NO.
-
CLANG_ASSISTED_PARSING = NO
-
-# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
-# YES then doxygen will add the directory of each input to the include path.
-# The default value is: YES.
-
CLANG_ADD_INC_PATHS = YES
-
-# If clang assisted parsing is enabled you can provide the compiler with command
-# line options that you would normally use when invoking the compiler. Note that
-# the include paths will already be set by doxygen for the files and directories
-# specified with INPUT and INCLUDE_PATH.
-# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
-
CLANG_OPTIONS =
-
-# If clang assisted parsing is enabled you can provide the clang parser with the
-# path to the directory containing a file called compile_commands.json. This
-# file is the compilation database (see:
-# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
-# options used when the source files were built. This is equivalent to
-# specifying the -p option to a clang tool, such as clang-check. These options
-# will then be passed to the parser. Any options specified with CLANG_OPTIONS
-# will be added as well.
-# Note: The availability of this option depends on whether or not doxygen was
-# generated with the -Duse_libclang=ON option for CMake.
-
CLANG_DATABASE_PATH =
-
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
-
-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
-# compounds will be generated. Enable this if the project contains a lot of
-# classes, structs, unions or interfaces.
-# The default value is: YES.
-
ALPHABETICAL_INDEX = YES
-
-# In case all classes in a project start with a common prefix, all classes will
-# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
-# can be used to specify a prefix (or a list of prefixes) that should be ignored
-# while generating the index headers.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
IGNORE_PREFIX =
-
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
-
-# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
-# The default value is: YES.
-
GENERATE_HTML = YES
-
-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
-# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
-# it.
-# The default directory is: html.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_OUTPUT = html
-
-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
-# generated HTML page (for example: .htm, .php, .asp).
-# The default value is: .html.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_FILE_EXTENSION = .html
-
-# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
-# each generated HTML page. If the tag is left blank doxygen will generate a
-# standard header.
-#
-# To get valid HTML the header file that includes any scripts and style sheets
-# that doxygen needs, which is dependent on the configuration options used (e.g.
-# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
-# default header using
-# doxygen -w html new_header.html new_footer.html new_stylesheet.css
-# YourConfigFile
-# and then modify the file new_header.html. See also section "Doxygen usage"
-# for information on how to generate the default header that doxygen normally
-# uses.
-# Note: The header is subject to change so you typically have to regenerate the
-# default header when upgrading to a newer version of doxygen. For a description
-# of the possible markers and block names see the documentation.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_HEADER =
-
-# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
-# generated HTML page. If the tag is left blank doxygen will generate a standard
-# footer. See HTML_HEADER for more information on how to generate a default
-# footer and what special commands can be used inside the footer. See also
-# section "Doxygen usage" for information on how to generate the default footer
-# that doxygen normally uses.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_FOOTER =
-
-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
-# sheet that is used by each HTML page. It can be used to fine-tune the look of
-# the HTML output. If left blank doxygen will generate a default style sheet.
-# See also section "Doxygen usage" for information on how to generate the style
-# sheet that doxygen normally uses.
-# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
-# it is more robust and this tag (HTML_STYLESHEET) will in the future become
-# obsolete.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_STYLESHEET =
-
-# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
-# cascading style sheets that are included after the standard style sheets
-# created by doxygen. Using this option one can overrule certain style aspects.
-# This is preferred over using HTML_STYLESHEET since it does not replace the
-# standard style sheet and is therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra style sheet files is of importance (e.g. the last
-# style sheet in the list overrules the setting of the previous ones in the
-# list). For an example see the documentation.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_EXTRA_STYLESHEET =
-
-# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
-# other source files which should be copied to the HTML output directory. Note
-# that these files will be copied to the base HTML output directory. Use the
-# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
-# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
-# files will be copied as-is; there are no commands or markers available.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_EXTRA_FILES =
-
-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
-# will adjust the colors in the style sheet and background images according to
-# this color. Hue is specified as an angle on a colorwheel, see
-# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
-# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
-# purple, and 360 is red again.
-# Minimum value: 0, maximum value: 359, default value: 220.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
+HTML_COLORSTYLE = AUTO_LIGHT
HTML_COLORSTYLE_HUE = 220
-
-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
-# in the HTML output. For a value of 0 the output will use grayscales only. A
-# value of 255 will produce the most vivid colors.
-# Minimum value: 0, maximum value: 255, default value: 100.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_COLORSTYLE_SAT = 100
-
-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
-# luminance component of the colors in the HTML output. Values below 100
-# gradually make the output lighter, whereas values above 100 make the output
-# darker. The value divided by 100 is the actual gamma applied, so 80 represents
-# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
-# change the gamma.
-# Minimum value: 40, maximum value: 240, default value: 80.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_COLORSTYLE_GAMMA = 80
-
-# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
-# page will contain the date and time when the page was generated. Setting this
-# to YES can help to show when doxygen was last run and thus if the
-# documentation is up to date.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_TIMESTAMP = YES
-
-# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
-# documentation will contain a main index with vertical navigation menus that
-# are dynamically created via JavaScript. If disabled, the navigation index will
-# consists of multiple levels of tabs that are statically embedded in every HTML
-# page. Disable this option to support browsers that do not have JavaScript,
-# like the Qt help browser.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_DYNAMIC_MENUS = YES
-
-# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
-# documentation will contain sections that can be hidden and shown after the
-# page has loaded.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
HTML_DYNAMIC_SECTIONS = NO
-
-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
-# shown in the various tree structured indices initially; the user can expand
-# and collapse entries dynamically later on. Doxygen will expand the tree to
-# such a level that at most the specified number of entries are visible (unless
-# a fully collapsed tree already exceeds this amount). So setting the number of
-# entries 1 will produce a full collapsed tree by default. 0 is a special value
-# representing an infinite number of entries and will result in a full expanded
-# tree by default.
-# Minimum value: 0, maximum value: 9999, default value: 100.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
+HTML_CODE_FOLDING = YES
HTML_INDEX_NUM_ENTRIES = 100
-
-# If the GENERATE_DOCSET tag is set to YES, additional index files will be
-# generated that can be used as input for Apple's Xcode 3 integrated development
-# environment (see:
-# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
-# create a documentation set, doxygen will generate a Makefile in the HTML
-# output directory. Running make will produce the docset in that directory and
-# running make install will install the docset in
-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
-# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
-# genXcode/_index.html for more information.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
GENERATE_DOCSET = NO
-
-# This tag determines the name of the docset feed. A documentation feed provides
-# an umbrella under which multiple documentation sets from a single provider
-# (such as a company or product suite) can be grouped.
-# The default value is: Doxygen generated docs.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
DOCSET_FEEDNAME = "Doxygen generated docs"
-
-# This tag specifies a string that should uniquely identify the documentation
-# set bundle. This should be a reverse domain-name style string, e.g.
-# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
-# The default value is: org.doxygen.Project.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
+DOCSET_FEEDURL =
DOCSET_BUNDLE_ID = org.doxygen.Project
-
-# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
-# the documentation publisher. This should be a reverse domain-name style
-# string, e.g. com.mycompany.MyDocSet.documentation.
-# The default value is: org.doxygen.Publisher.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
-
-# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
-# The default value is: Publisher.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
DOCSET_PUBLISHER_NAME = Publisher
-
-# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
-# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
-# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
-# (see:
-# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
-#
-# The HTML Help Workshop contains a compiler that can convert all HTML output
-# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
-# files are now used as the Windows 98 help format, and will replace the old
-# Windows help format (.hlp) on all Windows platforms in the future. Compressed
-# HTML files also contain an index, a table of contents, and you can search for
-# words in the documentation. The HTML workshop also contains a viewer for
-# compressed HTML files.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
GENERATE_HTMLHELP = NO
-
-# The CHM_FILE tag can be used to specify the file name of the resulting .chm
-# file. You can add a path in front of the file if the result should not be
-# written to the html output directory.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
CHM_FILE =
-
-# The HHC_LOCATION tag can be used to specify the location (absolute path
-# including file name) of the HTML help compiler (hhc.exe). If non-empty,
-# doxygen will try to run the HTML help compiler on the generated index.hhp.
-# The file has to be specified with full path.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
HHC_LOCATION =
-
-# The GENERATE_CHI flag controls if a separate .chi index file is generated
-# (YES) or that it should be included in the main .chm file (NO).
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
GENERATE_CHI = NO
-
-# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
-# and project file content.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
CHM_INDEX_ENCODING =
-
-# The BINARY_TOC flag controls whether a binary table of contents is generated
-# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
-# enables the Previous and Next buttons.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
BINARY_TOC = NO
-
-# The TOC_EXPAND flag can be set to YES to add extra items for group members to
-# the table of contents of the HTML help documentation and to the tree view.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
TOC_EXPAND = NO
-
-# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
-# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
-# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
-# (.qch) of the generated HTML documentation.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
+SITEMAP_URL =
GENERATE_QHP = NO
-
-# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
-# the file name of the resulting .qch file. The path specified is relative to
-# the HTML output folder.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
QCH_FILE =
-
-# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
-# Project output. For more information please see Qt Help Project / Namespace
-# (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
-# The default value is: org.doxygen.Project.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
QHP_NAMESPACE = org.doxygen.Project
-
-# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
-# Help Project output. For more information please see Qt Help Project / Virtual
-# Folders (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
-# The default value is: doc.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
QHP_VIRTUAL_FOLDER = doc
-
-# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
-# filter to add. For more information please see Qt Help Project / Custom
-# Filters (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
QHP_CUST_FILTER_NAME =
-
-# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
-# custom filter to add. For more information please see Qt Help Project / Custom
-# Filters (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
QHP_CUST_FILTER_ATTRS =
-
-# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
-# project's filter section matches. Qt Help Project / Filter Attributes (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
QHP_SECT_FILTER_ATTRS =
-
-# The QHG_LOCATION tag can be used to specify the location (absolute path
-# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
-# run qhelpgenerator on the generated .qhp file.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
QHG_LOCATION =
-
-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
-# generated, together with the HTML files, they form an Eclipse help plugin. To
-# install this plugin and make it available under the help contents menu in
-# Eclipse, the contents of the directory containing the HTML and XML files needs
-# to be copied into the plugins directory of eclipse. The name of the directory
-# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
-# After copying Eclipse needs to be restarted before the help appears.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
GENERATE_ECLIPSEHELP = NO
-
-# A unique identifier for the Eclipse help plugin. When installing the plugin
-# the directory name containing the HTML and XML files should also have this
-# name. Each documentation set should have its own identifier.
-# The default value is: org.doxygen.Project.
-# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
-
ECLIPSE_DOC_ID = org.doxygen.Project
-
-# If you want full control over the layout of the generated HTML pages it might
-# be necessary to disable the index and replace it with your own. The
-# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
-# of each HTML page. A value of NO enables the index and the value YES disables
-# it. Since the tabs in the index contain the same information as the navigation
-# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
DISABLE_INDEX = NO
-
-# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
-# structure should be generated to display hierarchical information. If the tag
-# value is set to YES, a side panel will be generated containing a tree-like
-# index structure (just like the one that is generated for HTML Help). For this
-# to work a browser that supports JavaScript, DHTML, CSS and frames is required
-# (i.e. any modern browser). Windows users are probably better off using the
-# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
-# further fine-tune the look of the index. As an example, the default style
-# sheet generated by doxygen has an example that shows how to put an image at
-# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
-# the same information as the tab index, you could consider setting
-# DISABLE_INDEX to YES when enabling this option.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
GENERATE_TREEVIEW = YES
-
-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
-# doxygen will group on one line in the generated HTML documentation.
-#
-# Note that a value of 0 will completely suppress the enum values from appearing
-# in the overview section.
-# Minimum value: 0, maximum value: 20, default value: 4.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
+FULL_SIDEBAR = NO
ENUM_VALUES_PER_LINE = 4
-
-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
-# to set the initial width (in pixels) of the frame in which the tree is shown.
-# Minimum value: 0, maximum value: 1500, default value: 250.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
TREEVIEW_WIDTH = 250
-
-# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
-# external symbols imported via tag files in a separate window.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
EXT_LINKS_IN_WINDOW = YES
-
-# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
-# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
-# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
-# the HTML output. These images will generally look nicer at scaled resolutions.
-# Possible values are: png (the default) and svg (looks nicer but requires the
-# pdf2svg or inkscape tool).
-# The default value is: png.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
+OBFUSCATE_EMAILS = YES
HTML_FORMULA_FORMAT = png
-
-# Use this tag to change the font size of LaTeX formulas included as images in
-# the HTML documentation. When you change the font size after a successful
-# doxygen run you need to manually remove any form_*.png images from the HTML
-# output directory to force them to be regenerated.
-# Minimum value: 8, maximum value: 50, default value: 10.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
FORMULA_FONTSIZE = 10
-
-# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are not
-# supported properly for IE 6.0, but are supported on all modern browsers.
-#
-# Note that when changing this option you need to delete any form_*.png files in
-# the HTML output directory before the changes have effect.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-FORMULA_TRANSPARENT = YES
-
-# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
-# to create new LaTeX commands to be used in formulas as building blocks. See
-# the section "Including formulas" for details.
-
FORMULA_MACROFILE =
-
-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
-# https://www.mathjax.org) which uses client side JavaScript for the rendering
-# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
-# installed or if you want to formulas look prettier in the HTML output. When
-# enabled you may also need to install MathJax separately and configure the path
-# to it using the MATHJAX_RELPATH option.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
USE_MATHJAX = NO
-
-# When MathJax is enabled you can set the default output format to be used for
-# the MathJax output. See the MathJax site (see:
-# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
-# Possible values are: HTML-CSS (which is slower, but has the best
-# compatibility), NativeMML (i.e. MathML) and SVG.
-# The default value is: HTML-CSS.
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
+MATHJAX_VERSION = MathJax_2
MATHJAX_FORMAT = HTML-CSS
-
-# When MathJax is enabled you need to specify the location relative to the HTML
-# output directory using the MATHJAX_RELPATH option. The destination directory
-# should contain the MathJax.js script. For instance, if the mathjax directory
-# is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
-# Content Delivery Network so you can quickly see the result without installing
-# MathJax. However, it is strongly recommended to install a local copy of
-# MathJax from https://www.mathjax.org before deployment.
-# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
-
-# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
-# extension names that should be enabled during MathJax rendering. For example
-# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
MATHJAX_EXTENSIONS =
-
-# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
-# of code that will be used on startup of the MathJax code. See the MathJax site
-# (see:
-# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
-# example see the documentation.
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
MATHJAX_CODEFILE =
-
-# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
-# the HTML output. The underlying search engine uses javascript and DHTML and
-# should work on any modern browser. Note that when using HTML help
-# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
-# there is already a search function so this one should typically be disabled.
-# For large projects the javascript based search engine can be slow, then
-# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
-# search using the keyboard; to jump to the search box use + S
-# (what the is depends on the OS and browser, but it is typically
-# , /