From 6f543725ad108edf6db1be6db724cd7e2c63eefb Mon Sep 17 00:00:00 2001 From: cvvergara Date: Sat, 10 Aug 2024 19:43:45 -0600 Subject: [PATCH 1/2] (drivers) using vrp_ prefix on driver names --- include/drivers/compatibleVehicles_driver.h | 22 ++++---- include/drivers/optimize_driver.h | 28 ++++------- .../drivers/pgr_pickDeliverEuclidean_driver.h | 29 +++-------- include/drivers/pgr_pickDeliver_driver.h | 29 +++-------- include/drivers/pickDeliver_driver.h | 28 ++++------- include/drivers/vroom_driver.h | 15 ++---- src/compatibleVehicles/compatibleVehicles.c | 2 +- .../compatibleVehicles_driver.cpp | 2 +- src/optimize/optimize.c | 2 +- src/optimize/optimize_driver.cpp | 9 ++-- .../pgr_pickDeliverEuclidean_driver.cpp | 2 +- .../pgr_pickDeliver_driver.cpp | 2 +- src/pgr_pickDeliver/pickDeliver.c | 2 +- src/pgr_pickDeliver/pickDeliverEuclidean.c | 2 +- src/pickDeliver/pickDeliver.c | 2 +- src/pickDeliver/pickDeliver_driver.cpp | 2 +- src/vroom/vroom.c | 2 +- src/vroom/vroom_driver.cpp | 50 +++++++++---------- 18 files changed, 85 insertions(+), 145 deletions(-) diff --git a/include/drivers/compatibleVehicles_driver.h b/include/drivers/compatibleVehicles_driver.h index 795447087..1d426633c 100644 --- a/include/drivers/compatibleVehicles_driver.h +++ b/include/drivers/compatibleVehicles_driver.h @@ -49,21 +49,17 @@ typedef struct CompatibleVehicles_rt CompatibleVehicles_rt; extern "C" { #endif - /** @brief Driver for processing a "compatible vehicles" problem */ - void do_compatibleVehicles( - Orders_t customers_arr[], size_t total_customers, - Vehicle_t *vehicles_arr, size_t total_vehicles, - Matrix_cell_t *matrix_cells_arr, size_t total_cells, - Time_multipliers_t *multipliers_arr, size_t total_multipliers, +/** @brief Driver for processing a "compatible vehicles" problem */ +void vrp_do_compatibleVehicles( + Orders_t customers_arr[], size_t total_customers, + Vehicle_t *vehicles_arr, size_t total_vehicles, + Matrix_cell_t *matrix_cells_arr, size_t total_cells, + Time_multipliers_t *multipliers_arr, size_t total_multipliers, - double factor, + double, - CompatibleVehicles_rt **return_tuples, - size_t *return_count, - - char **log_msg, - char **notice_msg, - char **err_msg); + CompatibleVehicles_rt **, size_t*, + char**, char**, char**); #ifdef __cplusplus diff --git a/include/drivers/optimize_driver.h b/include/drivers/optimize_driver.h index 549266095..a9925a7e9 100644 --- a/include/drivers/optimize_driver.h +++ b/include/drivers/optimize_driver.h @@ -38,25 +38,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. extern "C" { #endif - /** @brief Driver for processing a pickupDeliver problem */ - void do_optimize( - Orders_t customers_arr[], size_t, - Vehicle_t *vehicles_arr, size_t, - Matrix_cell_t *, size_t, - Time_multipliers_t *, size_t, - - double, - int, - int64_t, - - bool, bool, bool, - - Short_vehicle_rt**, - size_t*, - - char**, - char**, - char**); +void vrp_do_optimize( + Orders_t customers_arr[], size_t, + Vehicle_t *vehicles_arr, size_t, + Matrix_cell_t *, size_t, + Time_multipliers_t *, size_t, + double, int, int64_t, bool, bool, bool, + + Short_vehicle_rt**, size_t*, + char**, char**, char**); #ifdef __cplusplus diff --git a/include/drivers/pgr_pickDeliverEuclidean_driver.h b/include/drivers/pgr_pickDeliverEuclidean_driver.h index bc1156c7b..84776ffd5 100644 --- a/include/drivers/pgr_pickDeliverEuclidean_driver.h +++ b/include/drivers/pgr_pickDeliverEuclidean_driver.h @@ -26,8 +26,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ********************************************************************PGR-GNU*/ -/*! @file pickDeliverEuclidean_driver.h */ - #ifndef INCLUDE_DRIVERS_PGR_PICKDELIVEREUCLIDEAN_DRIVER_H_ #define INCLUDE_DRIVERS_PGR_PICKDELIVEREUCLIDEAN_DRIVER_H_ #pragma once @@ -47,26 +45,13 @@ typedef struct Vehicle_t Vehicle_t; extern "C" { #endif - /********************************************************* - orders_sql TEXT, - max_vehicles INTEGER, - capacity FLOAT, - max_cycles INTEGER, - ********************************************************/ - void do_pgr_pickDeliverEuclidean( - Orders_t *pd_orders_arr, size_t total_pd_orders, - Vehicle_t *vehicles_arr, size_t total_vehicles, - - double factor, - int max_cycles, - int initial_solution_id, - - Solution_rt **return_tuples, - size_t *return_count, - - char **log_msg, - char **notice_msg, - char **err_msg); +void vrp_do_pgr_pickDeliverEuclidean( + Orders_t *pd_orders_arr, size_t total_pd_orders, + Vehicle_t *vehicles_arr, size_t total_vehicles, + double, int, int, + + Solution_rt**, size_t*, + char**, char**, char**); #ifdef __cplusplus diff --git a/include/drivers/pgr_pickDeliver_driver.h b/include/drivers/pgr_pickDeliver_driver.h index bff7a1641..e10a9bf07 100644 --- a/include/drivers/pgr_pickDeliver_driver.h +++ b/include/drivers/pgr_pickDeliver_driver.h @@ -49,27 +49,14 @@ typedef struct Solution_rt Solution_rt; extern "C" { #endif - /********************************************************* - orders_sql TEXT, - max_vehicles INTEGER, - capacity FLOAT, - max_cycles INTEGER, - ********************************************************/ - void do_pgr_pickDeliver( - Orders_t *pd_orders_arr, size_t total_pd_orders, - Vehicle_t *vehicles_arr, size_t total_vehicles, - Matrix_cell_t *matrix_cells_arr, size_t total_cells, - - double factor, - int max_cycles, - int initial_solution_id, - - Solution_rt **return_tuples, - size_t *return_count, - - char **log_msg, - char **notice_msg, - char **err_msg); +void vrp_do_pgr_pickDeliver( + Orders_t *pd_orders_arr, size_t total_pd_orders, + Vehicle_t *vehicles_arr, size_t total_vehicles, + Matrix_cell_t *matrix_cells_arr, size_t total_cells, + double, int, int, + + Solution_rt**, size_t*, + char**, char**, char**); #ifdef __cplusplus diff --git a/include/drivers/pickDeliver_driver.h b/include/drivers/pickDeliver_driver.h index 21a2bd726..f74156fb4 100644 --- a/include/drivers/pickDeliver_driver.h +++ b/include/drivers/pickDeliver_driver.h @@ -38,25 +38,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. extern "C" { #endif - /** @brief Driver for processing a pickupDeliver problem */ - void do_pickDeliver( - Orders_t customers_arr[], size_t total_customers, - Vehicle_t *vehicles_arr, size_t total_vehicles, - Matrix_cell_t *matrix_cells_arr, size_t total_cells, - Time_multipliers_t *multipliers_arr, size_t total_multipliers, - - bool, - double factor, - int max_cycles, - bool stop_on_all_served, - int64_t execution_date, - - Solution_rt **return_tuples, - size_t *return_count, - - char **log_msg, - char **notice_msg, - char **err_msg); +void vrp_do_pickDeliver( + Orders_t customers_arr[], size_t total_customers, + Vehicle_t *vehicles_arr, size_t total_vehicles, + Matrix_cell_t *matrix_cells_arr, size_t total_cells, + Time_multipliers_t *multipliers_arr, size_t total_multipliers, + bool, double, int, bool, int64_t, + + Solution_rt**, size_t*, + char**, char**, char**); #ifdef __cplusplus diff --git a/include/drivers/vroom_driver.h b/include/drivers/vroom_driver.h index 223343ccd..4d3158d9e 100644 --- a/include/drivers/vroom_driver.h +++ b/include/drivers/vroom_driver.h @@ -36,7 +36,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. extern "C" { #endif - void do_vrp_vroom( +void vrp_do_vroom( Vroom_job_t *jobs, size_t total_jobs, Vroom_time_window_t *jobs_tws, size_t total_jobs_tws, Vroom_shipment_t *shipments, size_t total_shipments, @@ -45,17 +45,10 @@ extern "C" { Vroom_break_t *breaks, size_t total_breaks, Vroom_time_window_t *breaks_tws, size_t total_breaks_tws, Vroom_matrix_t *matrix_cells_arr, size_t total_cells, + int32_t, int32_t, int32_t, - int32_t exploration_level, - int32_t timeout, - int32_t loading_time, - - Vroom_rt **return_tuples, - size_t *return_count, - - char ** log_msg, - char ** notice_msg, - char ** err_msg); + Vroom_rt**, size_t*, + char**, char**, char**); #ifdef __cplusplus } diff --git a/src/compatibleVehicles/compatibleVehicles.c b/src/compatibleVehicles/compatibleVehicles.c index 319b5f064..a33a8f531 100644 --- a/src/compatibleVehicles/compatibleVehicles.c +++ b/src/compatibleVehicles/compatibleVehicles.c @@ -179,7 +179,7 @@ process( char *notice_msg = NULL; char *err_msg = NULL; - do_compatibleVehicles( + vrp_do_compatibleVehicles( pd_orders_arr, total_pd_orders, vehicles_arr, total_vehicles, matrix_cells_arr, total_cells, diff --git a/src/compatibleVehicles/compatibleVehicles_driver.cpp b/src/compatibleVehicles/compatibleVehicles_driver.cpp index 5f41c67ca..10cb9a83c 100644 --- a/src/compatibleVehicles/compatibleVehicles_driver.cpp +++ b/src/compatibleVehicles/compatibleVehicles_driver.cpp @@ -95,7 +95,7 @@ digraph G { * */ void -do_compatibleVehicles( +vrp_do_compatibleVehicles( Orders_t customers_arr[], size_t total_customers, diff --git a/src/optimize/optimize.c b/src/optimize/optimize.c index 071019b4e..985ed4b61 100644 --- a/src/optimize/optimize.c +++ b/src/optimize/optimize.c @@ -210,7 +210,7 @@ process( char *notice_msg = NULL; char *err_msg = NULL; - do_optimize( + vrp_do_optimize( pd_orders_arr, total_pd_orders, vehicles_arr, total_vehicles, matrix_cells_arr, total_cells, diff --git a/src/optimize/optimize_driver.cpp b/src/optimize/optimize_driver.cpp index d3b17faed..3686f8263 100644 --- a/src/optimize/optimize_driver.cpp +++ b/src/optimize/optimize_driver.cpp @@ -296,10 +296,11 @@ subdivide_processing( * @param[in] total_cells size of the matrix_cells_arr * @param[in] multipliers_arr A C Array of the multipliers * @param[in] total_multipliers size of the multipliers_arr - * @param[in] optimize flag to control optimization * @param[in] factor A global multiplier for the (time) matrix cells * @param[in] max_cycles number of cycles to perform during the optimization phase - * @param[in] stop_on_all_served Indicator to stop optimization when all shipments are served + * @param[in] check_triangle_inequality When true tirangle inequality will be checked + * @param[in] subdivide @todo + * @param[in] subdivide_by_vehicle @todo * @param[in] execution_date Value used for not moving shipments that are before this date * @param[out] return_tuples C array of contents to be returned to postgres * @param[out] return_count number of tuples returned @@ -344,10 +345,8 @@ subdivide_processing( * */ - - void -do_optimize( +vrp_do_optimize( Orders_t *shipments_arr, size_t total_shipments, Vehicle_t *vehicles_arr, size_t total_vehicles, Matrix_cell_t *matrix_cells_arr, size_t total_cells, diff --git a/src/pgr_pickDeliver/pgr_pickDeliverEuclidean_driver.cpp b/src/pgr_pickDeliver/pgr_pickDeliverEuclidean_driver.cpp index d4dfc5a59..4a5546b49 100644 --- a/src/pgr_pickDeliver/pgr_pickDeliverEuclidean_driver.cpp +++ b/src/pgr_pickDeliver/pgr_pickDeliverEuclidean_driver.cpp @@ -118,7 +118,7 @@ are_shipments_ok( } // namespace void -do_pgr_pickDeliverEuclidean( +vrp_do_pgr_pickDeliverEuclidean( Orders_t *customers_arr, size_t total_customers, diff --git a/src/pgr_pickDeliver/pgr_pickDeliver_driver.cpp b/src/pgr_pickDeliver/pgr_pickDeliver_driver.cpp index c47ed1c57..f81afe373 100644 --- a/src/pgr_pickDeliver/pgr_pickDeliver_driver.cpp +++ b/src/pgr_pickDeliver/pgr_pickDeliver_driver.cpp @@ -72,7 +72,7 @@ vrprouting::problem::Solution } // namespace void -do_pgr_pickDeliver( +vrp_do_pgr_pickDeliver( struct Orders_t customers_arr[], size_t total_customers, diff --git a/src/pgr_pickDeliver/pickDeliver.c b/src/pgr_pickDeliver/pickDeliver.c index db39e4390..60ce2aea1 100644 --- a/src/pgr_pickDeliver/pickDeliver.c +++ b/src/pgr_pickDeliver/pickDeliver.c @@ -225,7 +225,7 @@ process( char *notice_msg = NULL; char *err_msg = NULL; - do_pgr_pickDeliver( + vrp_do_pgr_pickDeliver( pd_orders_arr, total_pd_orders, vehicles_arr, total_vehicles, matrix_cells_arr, total_cells, diff --git a/src/pgr_pickDeliver/pickDeliverEuclidean.c b/src/pgr_pickDeliver/pickDeliverEuclidean.c index 96b56c01e..24942dcf1 100644 --- a/src/pgr_pickDeliver/pickDeliverEuclidean.c +++ b/src/pgr_pickDeliver/pickDeliverEuclidean.c @@ -157,7 +157,7 @@ process( char *log_msg = NULL; char *notice_msg = NULL; char *err_msg = NULL; - do_pgr_pickDeliverEuclidean( + vrp_do_pgr_pickDeliverEuclidean( pd_orders_arr, total_pd_orders, vehicles_arr, total_vehicles, diff --git a/src/pickDeliver/pickDeliver.c b/src/pickDeliver/pickDeliver.c index 9f94b000e..ce92f5532 100644 --- a/src/pickDeliver/pickDeliver.c +++ b/src/pickDeliver/pickDeliver.c @@ -216,7 +216,7 @@ process( char *notice_msg = NULL; char *err_msg = NULL; - do_pickDeliver( + vrp_do_pickDeliver( pd_orders_arr, total_pd_orders, vehicles_arr, total_vehicles, matrix_cells_arr, total_cells, diff --git a/src/pickDeliver/pickDeliver_driver.cpp b/src/pickDeliver/pickDeliver_driver.cpp index 8d8a68ea9..8ae3a95c7 100644 --- a/src/pickDeliver/pickDeliver_driver.cpp +++ b/src/pickDeliver/pickDeliver_driver.cpp @@ -105,7 +105,7 @@ digraph G { * */ void -do_pickDeliver( +vrp_do_pickDeliver( Orders_t *customers_arr, size_t total_customers, Vehicle_t *vehicles_arr, size_t total_vehicles, Matrix_cell_t *matrix_cells_arr, size_t total_cells, diff --git a/src/vroom/vroom.c b/src/vroom/vroom.c index 0ba8dcf0b..4f3fa28d8 100644 --- a/src/vroom/vroom.c +++ b/src/vroom/vroom.c @@ -179,7 +179,7 @@ process( int32_t loading_time = (int)((clock() - start_loading) / CLOCKS_PER_SEC) * 1000; - do_vrp_vroom( + vrp_do_vroom( jobs, total_jobs, jobs_tws, total_jobs_tws, shipments, total_shipments, diff --git a/src/vroom/vroom_driver.cpp b/src/vroom/vroom_driver.cpp index 6a95b4807..91df5f20f 100644 --- a/src/vroom/vroom_driver.cpp +++ b/src/vroom/vroom_driver.cpp @@ -62,33 +62,33 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * function `vrp_vroom` which calls the main function defined in the * C++ Header file. It also does exception handling. * - * @param jobs Pointer to the array of jobs - * @param total_jobs The total number of jobs - * @param jobs_tws Pointer to the array of jobs time windows - * @param total_jobs_tws The total number of jobs time windows - * @param shipments Pointer to the array of shipments - * @param total_shipments The total number of shipments - * @param shipments_tws Pointer to the array of shipments time windows - * @param total_shipments_tws The total number of shipments time windows - * @param vehicles Pointer to the array of vehicles - * @param total_vehicles The total number of total vehicles - * @param breaks Pointer to the array of breaks - * @param total_breaks The total number of total breaks - * @param matrix_rows Pointer to the array of matrix rows - * @param total_matrix_rows The total number of matrix rows - * @param exploration_level Exploration level to use while solving. - * @param timeout Timeout value to stop the solving process (seconds). - * @param loading_timeout Additional time spent in loading the data from SQL Query (seconds). - * @param result_tuples The rows in the result - * @param result_count The count of rows in the result - * @param log_msg Stores the log message - * @param notice_msg Stores the notice message - * @param err_msg Stores the error message - * - * @returns void + * @param[in] jobs Pointer to the array of jobs + * @param[in] total_jobs The total number of jobs + * @param[in] jobs_tws Pointer to the array of jobs time windows + * @param[in] total_jobs_tws The total number of jobs time windows + * @param[in] shipments Pointer to the array of shipments + * @param[in] total_shipments The total number of shipments + * @param[in] shipments_tws Pointer to the array of shipments time windows + * @param[in] total_shipments_tws The total number of shipments time windows + * @param[in] vehicles Pointer to the array of vehicles + * @param[in] total_vehicles The total number of total vehicles + * @param[in] breaks Pointer to the array of breaks + * @param[in] total_breaks The total number of total breaks + * @param[in] breaks_tws Pointer to the array of break timewindows + * @param[in] total_breaks_tws The total number of total breaks timewindows + * @param[in] matrix_rows Pointer to the array of matrix rows + * @param[in] total_matrix_rows The total number of matrix rows + * @param[in] exploration_level Exploration level to use while solving. + * @param[in] timeout Timeout value to stop the solving process (seconds). + * @param[in] loading_time Additional time spent in loading the data from SQL Query (seconds). + * @param[out] return_tuples The rows in the result + * @param[out] return_count The count of rows in the result + * @param[out] log_msg Stores the log message + * @param[out] notice_msg Stores the notice message + * @param[out] err_msg Stores the error message */ void -do_vrp_vroom( +vrp_do_vroom( Vroom_job_t *jobs, size_t total_jobs, Vroom_time_window_t *jobs_tws, size_t total_jobs_tws, Vroom_shipment_t *shipments, size_t total_shipments, From 35df99e486d35d9b42a04c433cb93f5ccf250581 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Sat, 10 Aug 2024 19:44:21 -0600 Subject: [PATCH 2/2] (doxy) Removing doxygen errors --- include/cpp_common/get_check_data.hpp | 6 - src/common/vroom/breaks_input.c | 6 - src/common/vroom/jobs_input.c | 5 - src/common/vroom/matrix_input.c | 6 - src/common/vroom/shipments_input.c | 5 - src/common/vroom/time_windows_input.c | 10 -- src/common/vroom/vehicles_input.c | 5 - src/cpp_common/base_matrix.cpp | 7 +- src/cpp_common/get_check_data.c | 152 +++++++++++++------------- src/problem/fleet.cpp | 4 +- 10 files changed, 83 insertions(+), 123 deletions(-) diff --git a/include/cpp_common/get_check_data.hpp b/include/cpp_common/get_check_data.hpp index d70fb869d..fe28ee169 100644 --- a/include/cpp_common/get_check_data.hpp +++ b/include/cpp_common/get_check_data.hpp @@ -99,8 +99,6 @@ spi_getMaxTasks( TupleDesc *tupdesc, Column_info_t info); -/** @name timestamp related - * @{ */ /** @brief Converts timestamp to timestamp without timezone */ TTimestamp timestamp_without_timezone(TTimestamp timestamp); @@ -115,10 +113,7 @@ TTimestamp get_TTimestamp_plain(HeapTuple*, TupleDesc*, Column_info_t, TTimestam /** @brief gets a timestamp value from ANY-INTEGER > 0 */ TTimestamp get_PositiveTTimestamp_plain(HeapTuple*, TupleDesc*, Column_info_t, TTimestamp); -/* @} */ -/** @name interval related - * @{ */ /** @brief gets an interval value from postgres type INTERVAL */ TInterval get_TInterval(HeapTuple*, TupleDesc*, Column_info_t, TInterval); @@ -130,7 +125,6 @@ TInterval get_TInterval_plain(HeapTuple*, TupleDesc*, Column_info_t, TInterval); /** @brief gets an interval value from ANY-INTEGER > 0 */ TInterval get_PositiveTInterval_plain(HeapTuple*, TupleDesc*, Column_info_t, TInterval); -/* @} */ /** get Id from data */ Id get_Id(HeapTuple*, TupleDesc*, Column_info_t, Id); diff --git a/src/common/vroom/breaks_input.c b/src/common/vroom/breaks_input.c index c454fb311..290732d50 100644 --- a/src/common/vroom/breaks_input.c +++ b/src/common/vroom/breaks_input.c @@ -125,12 +125,6 @@ void db_get_breaks( } - -/** - * @param[in] sql SQL query to execute - * @param[out] rows C Container that holds the data - * @param[out] total_rows Total rows recieved - */ void get_vroom_breaks( char *sql, diff --git a/src/common/vroom/jobs_input.c b/src/common/vroom/jobs_input.c index 606be98bb..4894379b8 100644 --- a/src/common/vroom/jobs_input.c +++ b/src/common/vroom/jobs_input.c @@ -151,11 +151,6 @@ void db_get_jobs( } -/** - * @param[in] sql SQL query to execute - * @param[out] rows C Container that holds the data - * @param[out] total_rows Total rows recieved - */ void get_vroom_jobs( char *sql, diff --git a/src/common/vroom/matrix_input.c b/src/common/vroom/matrix_input.c index 9b4d15692..7f3a66db7 100644 --- a/src/common/vroom/matrix_input.c +++ b/src/common/vroom/matrix_input.c @@ -124,12 +124,6 @@ void db_get_matrix( } -/** - * @param [in] sql SQL query that has the following columns: start_id, end_id, duration, cost - * @param[in] is_plain Whether the plain or timestamp function is used - * @param [out] rows C Container that holds all the matrix rows - * @param [out] total_rows Total rows recieved - */ void get_vroom_matrix( char *sql, diff --git a/src/common/vroom/shipments_input.c b/src/common/vroom/shipments_input.c index 1ce42b5f0..1c66602fb 100644 --- a/src/common/vroom/shipments_input.c +++ b/src/common/vroom/shipments_input.c @@ -153,11 +153,6 @@ void db_get_shipments( } -/** - * @param[in] sql SQL query to execute - * @param[out] rows C Container that holds the data - * @param[out] total_rows Total rows recieved - */ void get_vroom_shipments( char *sql, diff --git a/src/common/vroom/time_windows_input.c b/src/common/vroom/time_windows_input.c index c7c212260..245dccea8 100644 --- a/src/common/vroom/time_windows_input.c +++ b/src/common/vroom/time_windows_input.c @@ -156,11 +156,6 @@ void db_get_time_windows( } -/** - * @param[in] sql SQL query to execute - * @param[out] rows C Container that holds the data - * @param[out] total_rows Total rows recieved - */ void get_vroom_time_windows( char *sql, @@ -191,11 +186,6 @@ get_vroom_time_windows( db_get_time_windows(sql, rows, total_rows, info, kColumnCount, 0, is_plain); } -/** - * @param[in] sql SQL query to execute - * @param[out] rows C Container that holds the data - * @param[out] total_rows Total rows recieved - */ void get_vroom_shipments_time_windows( char *sql, diff --git a/src/common/vroom/vehicles_input.c b/src/common/vroom/vehicles_input.c index 4b4f716d1..b04e7f7d7 100644 --- a/src/common/vroom/vehicles_input.c +++ b/src/common/vroom/vehicles_input.c @@ -169,11 +169,6 @@ void db_get_vehicles( } -/** - * @param[in] sql SQL query to execute - * @param[out] rows C Container that holds the data - * @param[out] total_rows Total rows recieved - */ void get_vroom_vehicles( char *sql, diff --git a/src/cpp_common/base_matrix.cpp b/src/cpp_common/base_matrix.cpp index f287a98ca..61786bab7 100644 --- a/src/cpp_common/base_matrix.cpp +++ b/src/cpp_common/base_matrix.cpp @@ -179,7 +179,7 @@ Base_Matrix::get_index(Id id) const { /** Given the internal index, returns the original node identifier * - * @param [in] id + * @param [in] index * @returns the original node identifier * @dot @@ -290,9 +290,10 @@ Base_Matrix::Base_Matrix( /** * @brief Constructor for VROOM matrix input * - * @param [in] data_costs The set of costs - * @param [in] size_matrix The size of the set of costs + * @param [in] matrix_rows The set of costs + * @param [in] total_matrix_rows The size of the set of costs * @param [in] location_ids The location identifiers + * @param [in] scaling_factor Multiplier * * @pre data_costs is not empty * @post ids has all the ids of node_ids diff --git a/src/cpp_common/get_check_data.c b/src/cpp_common/get_check_data.c index 3665839c1..2596048f5 100644 --- a/src/cpp_common/get_check_data.c +++ b/src/cpp_common/get_check_data.c @@ -410,10 +410,10 @@ spi_getPositiveIntArr_allowEmpty( /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -426,10 +426,10 @@ get_TTimestamp_plain(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, T } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -445,10 +445,10 @@ get_PositiveTTimestamp_plain(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -461,10 +461,10 @@ get_TTimestamp(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, TTimest } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -480,10 +480,10 @@ get_PositiveTTimestamp(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -496,10 +496,10 @@ get_TInterval(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, TInterva } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -515,10 +515,10 @@ get_PositiveTInterval(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -531,10 +531,10 @@ get_TInterval_plain(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, TI } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -550,10 +550,10 @@ get_PositiveTInterval_plain(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -566,10 +566,10 @@ get_Id(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, Id opt_value) { } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -585,10 +585,10 @@ get_Idx(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, Idx opt_value) } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -607,10 +607,10 @@ StepType get_StepType(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -623,10 +623,10 @@ get_Amount(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, Amount opt_ } /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -643,10 +643,10 @@ get_PositiveAmount(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, PAm /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -666,10 +666,10 @@ get_MatrixIndex(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, Matrix /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -689,10 +689,10 @@ get_Duration(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, Duration /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -712,10 +712,10 @@ get_Cost(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, TravelCost op /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -732,10 +732,10 @@ get_Kind(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, char opt_valu /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist @@ -756,10 +756,10 @@ get_Priority(HeapTuple *tuple, TupleDesc *tupdesc, Column_info_t info, Priority /** - * @params [in] tuple - * @params [in] tupdesc - * @params [in] info about the column been fetched - * @params [in] opt_value default value when the column does not exist + * @param[in] tuple + * @param[in] tupdesc + * @param[in] info about the column been fetched + * @param[in] opt_value default value when the column does not exist * * @returns The value found * @returns opt_value when the column does not exist diff --git a/src/problem/fleet.cpp b/src/problem/fleet.cpp index f71313f0d..7583d54a5 100644 --- a/src/problem/fleet.cpp +++ b/src/problem/fleet.cpp @@ -188,6 +188,7 @@ Fleet::is_order_ok(const Order &order) const { /** @param [in] vehicle +@param [in] new_stops @param [in] p_orders @param [in,out] p_nodes @param [in,out] node_id @@ -355,7 +356,8 @@ Fleet::set_compatibles(const Orders &orders) { builds a fleet from a vector of Vehicle_t @param[in] vehicles the list of vehicles - @param[in] size_vehicles size of vehicles + @param[in] size_vehicles + @param [in] new_stops overides vehicles stops @param[in] p_orders @param[in,out] p_nodes @param[in,out] node_id