orders_input.c

Go to the documentation of this file.

/*PGR-GNU*****************************************************************
File: pd_orders_input.c
 
Copyright (c) 2016 pgRouting developers
Mail: [email protected]
 
Developer:
Copyright (c) 2016 Celia Virginia Vergara Castillo
 
------
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 ********************************************************************PGR-GNU*/
 
#include "c_common/orders_input.h"
 
#include "c_types/pickDeliveryOrders_t.h"
#include "c_types/column_info_t.h"
 
#include "c_common/debug_macro.h"
#include "c_common/get_check_data.h"
#ifdef PROFILE
#include "c_common/time_msg.h"
#endif
 
 
/*
.. pgr_pickDeliver start
 
A ``SELECT`` statement that returns the following columns:
 
::
 
    id, amount
    p_id, p_tw_open, p_tw_close, [p_service,]
    d_id, d_tw_open, d_tw_close, [d_service]
 
 
================  ===================  =========== ================================================
Column            Type                 Default     Description
================  ===================  =========== ================================================
**id**            |ANY-INTEGER|                     Identifier of the pick-delivery order pair.
**amount**        |ANY-NUMERICAL|                   Number of units in the order
**p_id**          |ANY-INTEGER|                     The identifier of the pickup node.
**p_tw_open**     |ANY-NUMERICAL|                   The time, relative to 0, when the pickup location opens.
**p_tw_close**    |ANY-NUMERICAL|                   The time, relative to 0, when the pickup location closes.
**p_service**     |ANY-NUMERICAL|       0           The duration of the loading at the pickup location.
**d_id**          |ANY-INTEGER|                     The identifier of the delivery node.
**d_tw_open**     |ANY-NUMERICAL|                   The time, relative to 0, when the delivery location opens.
**d_tw_close**    |ANY-NUMERICAL|                   The time, relative to 0, when the delivery location closes.
**d_service**     |ANY-NUMERICAL|       0           The duration of the unloading at the delivery location.
================  ===================  =========== ================================================
 
.. pgr_pickDeliver end
 
.. pgr_pickDeliverEuclidean start
 
A ``SELECT`` statement that returns the following columns:
 
::
 
    id, amount
    p_x, p_y, p_tw_open, p_tw_close, [p_service,]
    d_x, d_y, d_tw_open, d_tw_close, [d_service]
 
 
================  ===================  =========== ================================================
Column            Type                 Default     Description
================  ===================  =========== ================================================
**id**            |ANY-INTEGER|                     Identifier of the pick-delivery order pair.
**amount**        |ANY-INTEGER|                     Number of units in the order
**p_x**           |ANY-NUMERICAL|                   :math:`x` value of the pick up location
**p_y**           |ANY-NUMERICAL|                   :math:`y` value of the pick up location
**p_tw_open**     |ANY-INTEGER|                     The time, relative to 0, when the pickup location opens.
**p_tw_close**    |ANY-INTEGER|                     The time, relative to 0, when the pickup location closes.
**p_service**     |ANY-INTEGER|         0           The duration of the loading at the pickup location.
**d_x**           |ANY-NUMERICAL|                   :math:`x` value of the delivery location
**d_y**           |ANY-NUMERICAL|                   :math:`y` value of the delivery location
**d_tw_open**     |ANY-INTEGER|                     The time, relative to 0, when the delivery location opens.
**d_tw_close**    |ANY-INTEGER|                     The time, relative to 0, when the delivery location closes.
**d_service**     |ANY-INTEGER|         0           The duration of the loading at the delivery location.
================  ===================  =========== ================================================
 
.. pgr_pickDeliverEuclidean end
 
.. vrp_pickDeliver start
 
A ``SELECT`` statement that returns the following columns:
 
::
 
    id, amount, requested_t
    p_id, p_tw_open, p_tw_close, [p_service,]
    d_id, d_tw_open, d_tw_close, [d_service]
 
 
================  ===================  =========== ================================================
Column            Type                 Default     Description
================  ===================  =========== ================================================
**id**            |ANY-INTEGER|                     Identifier of the pick-delivery order pair.
**amount**        |ANY-NUMERICAL|                   Number of units in the order
**requested_t**   |ANY-NUMERICAL|                   TODO define if it is going to be used
**p_id**          |ANY-INTEGER|                     The identifier of the pickup node.
**p_tw_open**     |ANY-NUMERICAL|                   The time, relative to 0, when the pickup location opens.
**p_tw_close**    |ANY-NUMERICAL|                   The time, relative to 0, when the pickup location closes.
**p_service**     |ANY-NUMERICAL|       0           The duration of the loading at the pickup location.
**d_id**          |ANY-INTEGER|                     The identifier of the delivery node.
**d_tw_open**     |ANY-NUMERICAL|                   The time, relative to 0, when the delivery location opens.
**d_tw_close**    |ANY-NUMERICAL|                   The time, relative to 0, when the delivery location closes.
**d_service**     |ANY-NUMERICAL|       0           The duration of the unloading at the delivery location.
================  ===================  =========== ================================================
 
.. vrp_pickDeliver end
*/
 
static
void fetch_euclidean(
    HeapTuple *tuple,
    TupleDesc *tupdesc,
    Column_info_t *info,
    PickDeliveryOrders_t *pd_order) {
  pd_order->id = get_Id(tuple, tupdesc, info[0], -1);
  pd_order->demand = get_PositiveAmount(tuple, tupdesc, info[1], 0);
 
  /*
   * the pickups
   */
  pd_order->pick_open_t    = get_TTimestamp_plain(tuple, tupdesc, info[2], -1);
  pd_order->pick_close_t   = get_TTimestamp_plain(tuple, tupdesc, info[3], -1);
  pd_order->pick_service_t = get_TInterval_plain(tuple, tupdesc, info[4], 0);
 
  /*
   * the deliveries
   */
  pd_order->deliver_open_t    = get_TTimestamp_plain(tuple, tupdesc, info[5], -1);
  pd_order->deliver_close_t   = get_TTimestamp_plain(tuple, tupdesc, info[6], -1);
  pd_order->deliver_service_t = get_TInterval_plain(tuple, tupdesc, info[7], 0);
 
  pd_order->pick_x =  spi_getCoordinate(tuple, tupdesc, info[8], 0);
  pd_order->pick_y =  spi_getCoordinate(tuple, tupdesc, info[9], 0);
  pd_order->deliver_x =  spi_getCoordinate(tuple, tupdesc, info[10], 0);
  pd_order->deliver_y =  spi_getCoordinate(tuple, tupdesc, info[11], 0);
 
  /*
   * ignored information
   */
  pd_order->pick_node_id = 0;
  pd_order->deliver_node_id = 0;
}
 
 
static
void fetch_raw(
    HeapTuple *tuple,
    TupleDesc *tupdesc,
    Column_info_t *info,
    PickDeliveryOrders_t *pd_order) {
  pd_order->id = get_Id(tuple, tupdesc, info[0], -1);
  pd_order->demand = get_PositiveAmount(tuple, tupdesc, info[1], 0);
 
  /*
   * the pickups
   */
  pd_order->pick_node_id   = get_Id(tuple, tupdesc, info[8], -1);
  pd_order->pick_open_t    = get_TTimestamp_plain(tuple, tupdesc, info[2], -1);
  pd_order->pick_close_t   = get_TTimestamp_plain(tuple, tupdesc, info[3], -1);
  pd_order->pick_service_t = get_TInterval_plain(tuple, tupdesc, info[4], 0);
 
  /*
   * the deliveries
   */
  pd_order->deliver_node_id   = get_Id(tuple, tupdesc, info[9], -1);
  pd_order->deliver_open_t    = get_TTimestamp_plain(tuple, tupdesc, info[5], -1);
  pd_order->deliver_close_t   = get_TTimestamp_plain(tuple, tupdesc, info[6], -1);
  pd_order->deliver_service_t = get_TInterval_plain(tuple, tupdesc, info[7], 0);
 
 
  /*
   * Ignored information
   */
  pd_order->pick_x =  0;
  pd_order->pick_y =  0;
  pd_order->deliver_x =  0;
  pd_order->deliver_y =  0;
}
 
static
void fetch_timestamps(
        HeapTuple *tuple,
        TupleDesc *tupdesc,
        Column_info_t *info,
        PickDeliveryOrders_t *pd_order) {
    pd_order->id = get_Id(tuple, tupdesc, info[0], -1);
    pd_order->demand = get_PositiveAmount(tuple, tupdesc, info[1], 0);
 
    /*
     * the pickups
     */
    pd_order->pick_node_id   = get_Id(tuple, tupdesc, info[2], -1);
    pd_order->pick_open_t    = get_TTimestamp(tuple, tupdesc, info[3], -1);
    pd_order->pick_close_t   = get_TTimestamp(tuple, tupdesc, info[4], -1);
    pd_order->pick_service_t = get_TInterval(tuple, tupdesc, info[5], 0);
 
    /*
     * the deliveries
     */
    pd_order->deliver_node_id   = get_Id(tuple, tupdesc, info[6], -1);
    pd_order->deliver_open_t    = get_TTimestamp(tuple, tupdesc, info[7], -1);
    pd_order->deliver_close_t   = get_TTimestamp(tuple, tupdesc, info[8], -1);
    pd_order->deliver_service_t = get_TInterval(tuple, tupdesc, info[9], 0);
 
    PGR_DBG("pick_service_t %ld deliver_service_t %ld", pd_order->pick_service_t, pd_order->deliver_service_t);
 
    /*
     * Ignored information
     */
    pd_order->pick_x =  0;
    pd_order->pick_y =  0;
    pd_order->deliver_x =  0;
    pd_order->deliver_y =  0;
}
 
 
 
static
void
pgr_get_pd_orders_general(
        char *pd_orders_sql,
        PickDeliveryOrders_t **pd_orders,
        size_t *total_pd_orders,
 
        Column_info_t *info,
        const int column_count,
 
        int kind) {
#ifdef PROFILE
    clock_t start_t = clock();
    PGR_DBG("%s", pd_orders_sql);
#endif
 
    const int tuple_limit = 1000000;
 
 
    size_t total_tuples;
 
    void *SPIplan;
    SPIplan = pgr_SPI_prepare(pd_orders_sql);
    Portal SPIportal;
    SPIportal = pgr_SPI_cursor_open(SPIplan);
 
    bool moredata = true;
    (*total_pd_orders) = total_tuples = 0;
 
    /* on the first tuple get the column numbers */
 
    while (moredata == true) {
        SPI_cursor_fetch(SPIportal, true, tuple_limit);
        if (total_tuples == 0) {
            pgr_fetch_column_info(info, column_count);
        }
        size_t ntuples = SPI_processed;
        total_tuples += ntuples;
        if (ntuples > 0) {
            if ((*pd_orders) == NULL)
                (*pd_orders) = (PickDeliveryOrders_t *)palloc0(
                        total_tuples * sizeof(PickDeliveryOrders_t));
            else
                (*pd_orders) = (PickDeliveryOrders_t *)repalloc(
                        (*pd_orders),
                        total_tuples * sizeof(PickDeliveryOrders_t));
 
            if ((*pd_orders) == NULL) {
                elog(ERROR, "Out of memory");
            }
 
            size_t t;
            SPITupleTable *tuptable = SPI_tuptable;
            TupleDesc tupdesc = SPI_tuptable->tupdesc;
            for (t = 0; t < ntuples; t++) {
                HeapTuple tuple = tuptable->vals[t];
                switch (kind) {
                case 0 : fetch_timestamps(&tuple, &tupdesc, info,
                        &(*pd_orders)[total_tuples - ntuples + t]);
                    break;
                case 1 : fetch_raw(&tuple, &tupdesc, info,
                        &(*pd_orders)[total_tuples - ntuples + t]);
                    break;
                case 2 : fetch_euclidean(&tuple, &tupdesc, info,
                        &(*pd_orders)[total_tuples - ntuples + t]);
                    break;
                }
            }
            SPI_freetuptable(tuptable);
        } else {
            moredata = false;
        }
    }
 
    SPI_cursor_close(SPIportal);
 
    if (total_tuples == 0) {
        (*total_pd_orders) = 0;
        return;
    }
 
    (*total_pd_orders) = total_tuples;
#ifdef PROFILE
    time_msg("reading shipments", start_t, clock());
#endif
}
 
void
get_shipments(
    char *sql,
    PickDeliveryOrders_t **rows,
    size_t *total_rows) {
  const int column_count = 10;
  Column_info_t info[10];
 
  for (int i = 0; i < column_count; ++i) {
    info[i].colNumber = -1;
    info[i].type = 0;
    info[i].strict = true;
    info[i].eType = ANY_INTEGER;
  }
 
  info[0].name = "id";
  info[1].name = "amount";
  info[2].name = "p_id";
  info[3].name = "p_tw_open";
  info[4].name = "p_tw_close";
  info[5].name = "p_t_service";
  info[6].name = "d_id";
  info[7].name = "d_tw_open";
  info[8].name = "d_tw_close";
  info[9].name = "d_t_service";
 
  info[3].eType = TIMESTAMP;
  info[4].eType = TIMESTAMP;
  info[7].eType = TIMESTAMP;
  info[8].eType = TIMESTAMP;
  info[5].eType = INTERVAL;
  info[9].eType = INTERVAL;
 
  /* service is optional*/
  info[5].strict = false;
  info[9].strict = false;
 
  pgr_get_pd_orders_general(sql, rows, total_rows, info, column_count, 0);
}
 
void
get_shipments_raw(
    char *sql,
    PickDeliveryOrders_t **rows,
    size_t *total_rows) {
  const int column_count = 10;
  Column_info_t info[10];
 
  for (int i = 0; i < column_count; ++i) {
    info[i].colNumber = -1;
    info[i].type = 0;
    info[i].strict = true;
    info[i].eType = ANY_INTEGER;
  }
 
  info[0].name = "id";
  info[1].name = "amount";
  info[2].name = "p_open";
  info[3].name = "p_close";
  info[4].name = "p_service";
  info[5].name = "d_open";
  info[6].name = "d_close";
  info[7].name = "d_service";
  info[8].name = "p_id";
  info[9].name = "d_id";
 
  /* service is optional*/
  info[4].strict = false;
  info[7].strict = false;
 
  pgr_get_pd_orders_general(sql, rows, total_rows, info, column_count, 1);
}
 
void
get_shipments_euclidean(
    char *sql,
    PickDeliveryOrders_t **rows,
    size_t *total_rows) {
  const int column_count = 12;
  Column_info_t info[12];
 
  for (int i = 0; i < column_count; ++i) {
    info[i].colNumber = -1;
    info[i].type = 0;
    info[i].strict = true;
    info[i].eType = ANY_INTEGER;
  }
 
  info[0].name = "id";
  info[1].name = "amount";
  info[2].name = "p_open";
  info[3].name = "p_close";
  info[4].name = "p_service";
  info[5].name = "d_open";
  info[6].name = "d_close";
  info[7].name = "d_service";
  info[8].name = "p_x";
  info[9].name = "p_y";
  info[10].name = "d_x";
  info[11].name = "d_y";
 
  /* service is optional*/
  info[4].strict = false;
  info[7].strict = false;
 
  /* (x,y) are ignored*/
  info[8].eType = ANY_NUMERICAL;
  info[9].eType = ANY_NUMERICAL;
  info[10].eType = ANY_NUMERICAL;
  info[11].eType = ANY_NUMERICAL;
 
  pgr_get_pd_orders_general(sql, rows, total_rows, info, column_count, 2);
}