Skip to content

create examples for advanced constraints #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
+953 −48
Open

create examples for advanced constraints #11

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5759b7b
create examples for advanced constraints
Olman62 Jan 11, 2022
f14c1ee
Update AlgorithmType.php
Olman62 Jan 11, 2022
95bddac
fix: fixed custom data example
Olman62 Apr 20, 2022
c967935
fix: fixed custom data example
Olman62 Apr 20, 2022
af7f76b
fix: fixed custom data example
Olman62 Apr 20, 2022
b1a79e5
fix: fixed custom data example
Olman62 Apr 20, 2022
05fb58c
fix: fixed custom data example
Olman62 Apr 20, 2022
3c1cad4
fix: fixed custom data example
Olman62 Apr 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 14 additions & 27 deletions UnitTestFiles/Test/OrderTests.php
View file
Original file line number Diff line number Diff line change
@@ -73,10 +73,8 @@ public static function setUpBeforeClass()
'EXT_FIELD_email' => '[email protected]',
'EXT_FIELD_phone' => '380380380380',
'EXT_FIELD_custom_data' => [
0 => [
'order_id' => '10',
'name' => 'Bill Soul',
],
'order_id' => '10',
'name' => 'Bill Soul'
],
]);

@@ -106,10 +104,8 @@ public function testFromArray()
'EXT_FIELD_email' => '[email protected]',
'EXT_FIELD_phone' => '380380380380',
'EXT_FIELD_custom_data' => [
0 => [
'order_id' => '10',
'name' => 'Bill Soul',
],
'order_id' => '10',
'name' => 'Bill Soul'
],
]);

@@ -124,11 +120,10 @@ public function testFromArray()
$this->assertEquals('[email protected]', $orderParameters->EXT_FIELD_email);
$this->assertEquals('380380380380', $orderParameters->EXT_FIELD_phone);
$this->assertEquals([
0 => [
'order_id' => '10',
'name' => 'Bill Soul',
],
], $orderParameters->EXT_FIELD_custom_data);
'order_id' => '10',
'name' => 'Bill Soul'
],
$orderParameters->EXT_FIELD_custom_data);
}

public function testToArray()
@@ -145,10 +140,8 @@ public function testToArray()
'EXT_FIELD_email' => '[email protected]',
'EXT_FIELD_phone' => '380380380380',
'EXT_FIELD_custom_data' => [
0 => [
'order_id' => '10',
'name' => 'Bill Soul',
],
'order_id' => '10',
'name' => 'Bill Soul'
],
]);

@@ -165,10 +158,8 @@ public function testToArray()
'EXT_FIELD_email' => '[email protected]',
'EXT_FIELD_phone' => '380380380380',
'EXT_FIELD_custom_data' => [
0 => [
'order_id' => '10',
'name' => 'Bill Soul',
],
'order_id' => '10',
'name' => 'Bill Soul'
],
]
);
@@ -473,9 +464,7 @@ public function testUpdateOrder()
self::$createdOrders[0]['address_2'] = 'Lviv';
self::$createdOrders[0]['EXT_FIELD_phone'] = '032268593';
self::$createdOrders[0]['EXT_FIELD_custom_data'] = [
0 => [
'customer_no' => '11',
],
'customer_no' => '11'
];

$response = $order->updateOrder(self::$createdOrders[0]);
@@ -485,9 +474,7 @@ public function testUpdateOrder()
$this->assertEquals('Lviv', $response['address_2']);
$this->assertEquals('032268593', $response['EXT_FIELD_phone']);
$this->assertEquals(
[
0 => [ 'customer_no' => '11' ],
],
[ 'customer_no' => '11' ],
$response['EXT_FIELD_custom_data']
);
}
6 changes: 2 additions & 4 deletions UnitTestFiles/Test/V5/data/update_order_data.json
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
{
"order_id": "7205711",
"address_2": "Lviv",
"EXT_FIELD_custom_data" : [
{
"EXT_FIELD_custom_data" : {
"customer_no" : 11
}
],
},
"EXT_FIELD_phone": "032268593"
}
6 changes: 2 additions & 4 deletions UnitTestFiles/Test/data/update_order_data.json
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
{
"order_id": "7205711",
"address_2": "Lviv",
"EXT_FIELD_custom_data" : [
{
"EXT_FIELD_custom_data" : {
"customer_no" : 11
}
],
},
"EXT_FIELD_phone": "032268593"
}
76 changes: 76 additions & 0 deletions examples/OptimizationWithAdvancedConstraints.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?php

namespace Route4Me;

$root = realpath(dirname(__FILE__).'/../');
require $root.'/vendor/autoload.php';

use Route4Me\Enum\OptimizationType;
use Route4Me\Enum\AlgorithmType;
use Route4Me\Enum\DistanceUnit;
use Route4Me\Enum\DeviceType;
use Route4Me\Enum\Metric;

// The example requires an API key with the enterprise subscription.

// Set the api key in the Route4me class
Route4Me::setApiKey(Constants::API_KEY);

// Huge list of addresses
$json = json_decode(file_get_contents('./addresses_adv_constr.json'), true);

$addresses = [];
foreach ($json as $address) {
$addresses[] = Address::fromArray($address);
}

$depots = [
Address::fromArray([
'alias' => 'Start Depot',
'address' => '1 MIAD Terminal J 2nd Floor, Miami,FL, (305) 876-0980',
'lat' => 25.774254,
'lng' => -80.190211
])
];

$parameters = RouteParameters::fromArray([
'algorithm_type' => Algorithmtype::ADVANCED_CVRP_TW,
'route_name' => 'Optimization With Same Last Location '.date('Y-m-d H:i:s', time()),
'route_date' => time() + 24 * 60 * 60,
'route_time' => 6 * 3600,
'distance_unit' => DistanceUnit::MILES,
'device_type' => DeviceType::WEB,
'optimize' => OptimizationType::DISTANCE,
'advanced_constraints' => [
[
'location_sequence_pattern' => [
'',
[
'alias' => 'End Depot',
'address' => '9681 SW 72nd St, Miami,FL, (305) 598-4933',
'lng' => -80.34972,
'lat' => 25.70185
]
]
]
],

]);

$optimizationParams = new OptimizationProblemParams();
$optimizationParams->setAddresses($addresses);
$optimizationParams->setDepots($depots);
$optimizationParams->setParameters($parameters);

$problem = OptimizationProblem::optimize($optimizationParams);
echo "<pre>";
foreach ((array) $problem as $key => $value) {
if (is_string($value)) {
echo $key.' --> '.$value.'<br>';
} else {
echo "************ $key ************* <br>";
Route4Me::simplePrint((array) $value, true);
echo '******************************* <br>';
}
}
echo "</pre>";
87 changes: 87 additions & 0 deletions examples/OptimizationWithAdvancedConstraintsMemberCount.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<?php

namespace Route4Me;

$root = realpath(dirname(__FILE__).'/../');
require $root.'/vendor/autoload.php';

use Route4Me\Enum\OptimizationType;
use Route4Me\Enum\AlgorithmType;
use Route4Me\Enum\DistanceUnit;
use Route4Me\Enum\DeviceType;
use Route4Me\Enum\Metric;
use Route4Me\Enum\TravelMode;

// The example requires an API key with the enterprise subscription.

// Set the api key in the Route4me class
Route4Me::setApiKey(Constants::API_KEY);

// Huge list of addresses
$json = json_decode(file_get_contents('./addresses_adv_constr2.json'), true);

$addresses = [];
foreach ($json as $address) {
$addresses[] = Address::fromArray($address);
}

$depots = [
Address::fromArray([
'alias' => 'Start Depot',
'is_depot' => true,
'address' => '1 Fritz Sonnenberg Rd, Green Point, Cape Town, 8051, South Africa',
'lat' => -33.90410680000001,
'lng' => 18.4010964
])
];

$parameters = RouteParameters::fromArray([
'rt' => 0,
'algorithm_type' => Algorithmtype::ADVANCED_CVRP_TW,
'route_name' => 'Optimization With Same Last Location and Member Count '.date('Y-m-d H:i:s', time()),
'route_date' => time() + 24 * 60 * 60,
'route_time' => 6 * 3600,
'distance_unit' => DistanceUnit::MILES,
'device_type' => DeviceType::WEB,
'optimize' => OptimizationType::DISTANCE,
'travel_mode' => TravelMode::DRIVING,
'route_max_duration' => 7200,
'store_route' => true,
'parts' => 2,
'parts_min' => 2,
'advanced_constraints' => [
[
'members_count' => 2,
'location_sequence_pattern' => [
'',
[
'lat' => -33.92136,
'lng' => 18.4181938,
'is_depot' => false,
'address' => '105 Bree St, Cape Town City Centre, Cape Town, 8001, South Africa',
'order_id' => 50,
'route_destination_id' => 736611941,
]
]
]
],

]);

$optimizationParams = new OptimizationProblemParams();
$optimizationParams->setAddresses($addresses);
$optimizationParams->setDepots($depots);
$optimizationParams->setParameters($parameters);

$problem = OptimizationProblem::optimize($optimizationParams);
echo "<pre>";
foreach ((array) $problem as $key => $value) {
if (is_string($value)) {
echo $key.' --> '.$value.'<br>';
} else {
echo "************ $key ************* <br>";
Route4Me::simplePrint((array) $value, true);
echo '******************************* <br>';
}
}
echo "</pre>";
6 changes: 2 additions & 4 deletions examples/Order/NewOrder.php
View file
Original file line number Diff line number Diff line change
@@ -23,11 +23,9 @@
'EXT_FIELD_email' => '[email protected]',
'EXT_FIELD_phone' => '380380380380',
'EXT_FIELD_custom_data' => [
0 => [
'order_id' => '10',
'name' => 'Bill Soul',
],
],
'name' => 'Bill Soul'
]
]);

$order = new Order();
4 changes: 1 addition & 3 deletions examples/Order/UpdateOrder.php
View file
Original file line number Diff line number Diff line change
@@ -25,9 +25,7 @@
$randomOrder['address_2'] = 'Lviv';
$randomOrder['EXT_FIELD_phone'] = '032268593';
$randomOrder['EXT_FIELD_custom_data'] = [
0 => [
'customer_no' => '11',
],
'customer_no' => '11'
];

$response = $order->updateOrder($randomOrder);
6 changes: 2 additions & 4 deletions examples/Order/update_order_data.json
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
{
"order_id": "7205711",
"address_2": "Lviv",
"EXT_FIELD_custom_data" : [
{
"EXT_FIELD_custom_data" : {
"customer_no" : 11
}
],
},
"EXT_FIELD_phone": "032268593"
}
415 changes: 415 additions & 0 deletions examples/addresses_adv_constr.json
View file

Large diffs are not rendered by default.

352 changes: 352 additions & 0 deletions examples/addresses_adv_constr2.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,352 @@
[
{
"address": "Albow Ctr, Hatfield St, Cape Town City Centre, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9294",
"lng": "18.416649",
"order_id": 0
},
{
"address": "28 Bay View, Tamboerskloof, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9297095",
"lng": "18.3991118",
"order_id": 1
},
{
"address": "De Roos St, Zonnebloem, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.928036",
"lng": "18.428898",
"order_id": 2
},
{
"address": "10 Ave protea, Fresnaye, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9236307",
"lng": "18.3880934",
"order_id": 3
},
{
"address": "160 Sir Lowry Rd, Zonnebloem, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.9277289",
"lng": "18.4371343",
"order_id": 4
},
{
"address": "179 Buitengracht St, Gardens, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.926305",
"lng": "18.4116006",
"order_id": 5
},
{
"address": "16 Kimberley Rd, Observatory, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.9400943",
"lng": "18.4714619",
"order_id": 6
},
{
"address": "19 Rosmead Ave, Gardens, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9389815",
"lng": "18.4080165",
"order_id": 7
},
{
"address": "Beach Rd, Three Anchor Bay, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9081432",
"lng": "18.3954149",
"order_id": 8
},
{
"address": "5th Floor, 22 Long St, Cape Town City Centre, Cape Town, 8000, South Africa",
"is_depot": false,
"lat": "-33.9201966",
"lng": "18.4213882",
"order_id": 9
},
{
"address": "160 Sir Lowry Rd, Zonnebloem, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.9277289",
"lng": "18.4371343",
"order_id": 10
},
{
"address": "Wembley Square, Roodehek St, Gardens, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9327695",
"lng": "18.4230611",
"order_id": 11
},
{
"address": "323 Beach Rd, Bantry Bay, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.923209",
"lng": "18.3778997",
"order_id": 12
},
{
"address": "239 Beach Rd, Sea Point, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9130286",
"lng": "18.3885208",
"order_id": 13
},
{
"address": "Bantry Bay 1, Bantry Bay, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9265221",
"lng": "18.3789738",
"order_id": 14
},
{
"address": "8 Briar Rd, Salt River, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.9319045",
"lng": "18.4589113",
"order_id": 15
},
{
"address": "Albow Ctr, Hatfield St, Cape Town City Centre, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9294",
"lng": "18.416649",
"order_id": 16
},
{
"address": "23 Derry St, Vredehoek, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9385199",
"lng": "18.42734",
"order_id": 17
},
{
"address": "125 Longmarket St, Cape Town City Centre, Cape Town, 8000, South Africa",
"is_depot": false,
"lat": "-33.9237964",
"lng": "18.421624",
"order_id": 18
},
{
"address": "13 Devonshire St, Woodstock, Cape Town, 7915, South Africa",
"is_depot": false,
"lat": "-33.9360033",
"lng": "18.4523871",
"order_id": 19
},
{
"address": "26 Rhodes Ave, University Estate, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.93821",
"lng": "18.4513399",
"order_id": 20
},
{
"address": "2nd Floor, 66 Plein St, Cape Town City Centre, Cape Town, 8000, South Africa",
"is_depot": false,
"lat": "-33.9258763",
"lng": "18.4212556",
"order_id": 21
},
{
"address": "24 Richmond Rd, Mowbray, Cape Town, 7700, South Africa",
"is_depot": false,
"lat": "-33.9462844",
"lng": "18.4813678",
"order_id": 22
},
{
"address": "35 Beach Rd, Mouille Point, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.8999958",
"lng": "18.4078875",
"order_id": 23
},
{
"address": "25 Merriman Rd, Signal Hill, Cape Town, 8051, South Africa",
"is_depot": false,
"lat": "-33.9131687",
"lng": "18.4095001",
"order_id": 24
},
{
"address": "18 Upper Pepper St, Schotsche Kloof, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.92283",
"lng": "18.41365",
"order_id": 25
},
{
"address": "7 Beatty Rd, University Estate, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.938175",
"lng": "18.451614",
"order_id": 26
},
{
"address": "10th Floor, 35 Lower Long St, Cape Town City Centre, Cape Town, 8000, South Africa",
"is_depot": false,
"lat": "-33.9178987",
"lng": "18.4245626",
"order_id": 27
},
{
"address": "4 Loop St, Cape Town City Centre, Cape Town, 8000, South Africa",
"is_depot": false,
"lat": "-33.9179479",
"lng": "18.4225973",
"order_id": 28
},
{
"address": "14 Kei Apple Rd, Sea Point, Cape Town, 8060, South Africa",
"is_depot": false,
"lat": "-33.9215342",
"lng": "18.3836797",
"order_id": 29
},
{
"address": "9 Davenport Rd, Vredehoek, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9406358",
"lng": "18.4197181",
"order_id": 30
},
{
"address": "31 Burnside Rd, Tamboerskloof, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9282",
"lng": "18.4050958",
"order_id": 31
},
{
"address": "011, Jocyn Court, 19 Rochester Rd, Bantry Bay, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9255484",
"lng": "18.3800261",
"order_id": 32
},
{
"address": "14 Tuin Plein, Cape Town City Centre, Cape Town, 8000, South Africa",
"is_depot": false,
"lat": "-33.9297236",
"lng": "18.4185608",
"order_id": 33
},
{
"address": "299 Beach Rd, Sea Point, Cape Town, 8060, South Africa",
"is_depot": false,
"lat": "-33.9203532",
"lng": "18.3818329",
"order_id": 34
},
{
"address": "3 Ella St, Schotsche Kloof, Cape Town, 8051, South Africa",
"is_depot": false,
"lat": "-33.9165727",
"lng": "18.4136263",
"order_id": 35
},
{
"address": "Sea Point, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9206032",
"lng": "18.3930108",
"order_id": 36
},
{
"address": "33 Ludlow Rd, Vredehoek, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9388796",
"lng": "18.4241053",
"order_id": 37
},
{
"address": "59 Victoria Rd, Clifton, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9371518",
"lng": "18.3783157",
"order_id": 38
},
{
"address": "V&A Waterfront Shop 7223, Victoria Wharf Shopping Centre, Victoria & Alfred Waterfront, Cape Town, 8002, South Africa",
"is_depot": false,
"lat": "-33.9024366",
"lng": "18.421185",
"order_id": 39
},
{
"address": "7 Campground Rd, Mowbray, Cape Town, 7700, South Africa",
"is_depot": false,
"lat": "-33.950007",
"lng": "18.4812287",
"order_id": 40
},
{
"address": "19 Upper Orange St, Oranjezicht, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9354079",
"lng": "18.4142753",
"order_id": 41
},
{
"address": "42 Earl St, Woodstock, Cape Town, 7915, South Africa",
"is_depot": false,
"lat": "-33.9306316",
"lng": "18.4472121",
"order_id": 42
},
{
"address": "Highlands Estate, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-34.0129346",
"lng": "18.5455744",
"order_id": 43
},
{
"address": "Beach Rd, Woodstock, Cape Town, 7915, South Africa",
"is_depot": false,
"lat": "-33.9247362",
"lng": "18.4466721",
"order_id": 44
},
{
"address": "297 High Level Rd, Fresnaye, Cape Town, 8005, South Africa",
"is_depot": false,
"lat": "-33.9215721",
"lng": "18.3894228",
"order_id": 45
},
{
"address": "0B Prestwich St, De Waterkant, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.912734",
"lng": "18.4177486",
"order_id": 46
},
{
"address": "7 Campground Rd, Mowbray, Cape Town, 7700, South Africa",
"is_depot": false,
"lat": "-33.950007",
"lng": "18.4812287",
"order_id": 47
},
{
"address": "1 Seymour St, Observatory, Cape Town, 7925, South Africa",
"is_depot": false,
"lat": "-33.93522",
"lng": "18.47028",
"order_id": 48
},
{
"address": "4 Stirling St, Zonnebloem, Cape Town, 8001, South Africa",
"is_depot": false,
"lat": "-33.9319567",
"lng": "18.4261389",
"order_id": 49
}
]
2 changes: 0 additions & 2 deletions src/Route4Me/Enum/AlgorithmType.php
View file
Original file line number Diff line number Diff line change
@@ -4,14 +4,12 @@

class AlgorithmType
{
const STATE_NEW = 0;
const TSP = 1;
const VRP = 2;
const CVRP_TW_SD = 3;
const CVRP_TW_MD = 4;
const TSP_TW = 5;
const TSP_TW_CR = 6;
const OPTIMIZATION_STATE_IN_QUEUE = 7;
const ADVANCED_CVRP_TW = 9;
const ALG_NONE = 100;
const ALG_LEGACY_DISTRIBUTED = 101;