NAME
Map::Tube::Cookbook - Cookbook for Map::Tube library.
VERSION
Version 3.96
DESCRIPTION
Cookbook for Map::Tube library.
CREATE A MAP
Map::Tube v3.22 or above now supports map data in XML and JSON format. Here is the structure of a map in XML format:
<?xml version="1.0" encoding="UTF-8"?>
<tube name="Your-Map-Name">
<lines>
<line id="Line-ID"
name="Line-Name"
color="Line-Color-Code" />
.....
.....
.....
.....
</lines>
<stations>
<station id="Station-ID"
name="Station-Name"
line="Line-ID:Station-Index"
link="Station-ID"
other_link="Link-Name:Station-ID" />
.....
.....
.....
.....
</stations>
</tube>And the same in JSON format:
{
"name" : "Your-Map-Name",
"lines" : {
"line" : [
{ "id" : "Line-ID",
"name" : "Line-Name",
"color" : "Line-Color-Code"
},
.....
.....
.....
.....
]
},
"stations" : {
"station" : [
{ "id" : "Station-ID",
"name" : "Station-Name",
"line" : "Line-ID:Station-Index",
"link" : "Station-ID",
"other_link" : "Link-Name:Station-ID"
},
.....
.....
.....
.....
]
}
}A more rigorous description of the requirements will be given below. Let us start with an informal introduction.
The root of the XML data is tube which has one optional attribute name, i.e. map name, and two children: lines and stations.
The node lines has one or more line children. The node line defines one 'line' of the map. The node line has to have the attributes id and name. Optionally it can have color as well. They are explained below:
+-----------+---------------------------------------------------------------+
| Attribute | Description |
+-----------+---------------------------------------------------------------+
| | |
| id | Unique line id of the map. Ideally should be numeric but can |
| | be alphanumeric. It shouldn't contain "," or ":". |
| | |
| name | Line name of the map. It should be unique since this name is |
| | what end users will typically use. |
| | |
| color | Line color is optional. It should have color name or hexcode. |
| | |
+-----------+---------------------------------------------------------------+Example from Map::Tube::Delhi as shown below:
<line id="Red" name="Red" color="#8B0000" />The node stations has one or more station children. The node station is used to represent a 'station' of the map. It must have attributes id, name, line and link. It can optionally have an attribute other_link.
+------------+--------------------------------------------------------------+
| Attribute | Description |
+------------+--------------------------------------------------------------+
| | |
| id | Unique station id of the map. Ideally should be numeric but |
| | can be alphanumeric. It shouldn't contain ",". |
| | |
| name | Station name of the map. It should be unique since this name |
| | is what end users will typically use. |
| | |
| line | Represents the station line along with the station index on |
| | the line. It should be ":" separated, e.g. "Red:2", meaning |
| | this is the second station on line 'Red'. Station index |
| | is NOT mandatory but nice to have. If the station is served |
| | by more than one line, they should all be listed, separated |
| | by ",". For example, "Red:9,Green:16". |
| | The lines are referenced by id, not by name. |
| | |
| link | Represents all linked stations to this station, e.g. "B04" |
| | If it is linked to more than one station, they should all be |
| | listed, separated by ",". For example, "B04,B02". |
| | The stations are referenced by id, not by name. |
| | |
| other_link | This attribute is optional. This is useful if the station is |
| | linked via some other form of link and not by any of the |
| | lines, e.g., some stations are linked by tunnel. |
| | This can be defined as "Tunnel:B02". |
| | |
+------------+--------------------------------------------------------------+Example from Map::Tube::London without station index:
<station id="B003"
name="Bank"
line="Central,DLR,Northern,Waterloo & City"
link="S002,S024,L013,M011,L012,W008"
other_link="Tunnel:M009" />Example from Map::Tube::Delhi with station index:
<station id="B03"
name="Dwarka Sector 9"
line="Blue:3"
link="B04,B02" />Let us create an XML map for the following map:
A(1) ---- B(2)
/ \
C(3) -------- F(6) --- G(7) ---- H(8)
\ /
D(4) ---- E(5)Below is the XML representation sample.xml of the above map:
<?xml version="1.0" encoding="UTF-8"?>
<tube name="Sample">
<lines>
<line id="L1" name="L1" />
</lines>
<stations>
<station id="L01" name="A" line="L1:1" link="L02,L03" />
<station id="L02" name="B" line="L1:2" link="L01,L06" />
<station id="L03" name="C" line="L1:3" link="L01,L04,L06" />
<station id="L04" name="D" line="L1:4" link="L03,L05" />
<station id="L05" name="E" line="L1:5" link="L04,L06" />
<station id="L06" name="F" line="L1:6" link="L02,L03,L05,L07" />
<station id="L07" name="G" line="L1:7" link="L06,L08" />
<station id="L08" name="H" line="L1:8" link="L07" />
</stations>
</tube>Next is the JSON representation sample.json of the above map:
{
"name" : "Sample",
"lines" : { "line" : [ { "id" : "L1", "name" : "L1" } ] },
"stations" : { "station" : [ { "id" : "L01", "name": "A", "line": "L1:1", "link": "L02,L03" },
{ "id" : "L02", "name": "B", "line": "L1:2", "link": "L01,L06" },
{ "id" : "L03", "name": "C", "line": "L1:3", "link": "L01,L04,L06" },
{ "id" : "L04", "name": "D", "line": "L1:4", "link": "L03,L05" },
{ "id" : "L05", "name": "E", "line": "L1:5", "link": "L04,L06" },
{ "id" : "L06", "name": "F", "line": "L1:6", "link": "L02,L03,L05,L07" },
{ "id" : "L07", "name": "G", "line": "L1:7", "link": "L06,L08" },
{ "id" : "L08", "name": "H", "line": "L1:8", "link": "L07" }
]
}
}FORMAL REQUIREMENTS FOR MAPS
These are the requirements for map files. (In the following we will use XML syntax and terminology, which straightforwardly translates into JSON.)
Map files SHOULD be UTF8-coded.
The top level element MUST be a
<tube>element. It MAY have anameattribute giving the human-readable name of the map. It MAY also have other attributes, which will in general be ignored by Map::Tube.Under
<tube>, there MUST be exactly one<lines>and exactly one<stations>element.Under the
<lines>element, there MUST be one or more<line>elements, each completely defining one tube line.Each tube line used in the map MUST have exactly one defining
<line>element. All defined lines MUST be mentioned at at least two stations.Each
<line>element MUST have anidattribute and anameattribute. It MAY have acolorattribute. It MAY also have other attributes, which will in general be ignored by Map::Tube.The value of the
idattribute SHOULD consist of 7-bit printing characters without spaces. It MUST NOT contain a comma (",") or a colon (":"). In general, it will be a rather short string, but this is not required. EachidMUST be unique among the lines. Lineids are case-insensitive, so any two lineids must not differ only in case. Any lineidSHOULD not occur also as a stationid.ids are usually not seen by end users.The
nameattribute MAY be any string. It SHOULD be unique among the lines (but it MAY be the same as a stationname). Typically, end users will interact with these names, so this should be kept in mind when choosing names.The
colorattribute MAY specify the color which graphical representations of the map SHOULD use for this line. The value MUST be either a color in HTML-style triple-hexadecimal code (#RRGGBB) or one of a set of color names predefined by Map::Tube::Utils (q.v.).Under the
<stations>element, there MUST be two or more<station>elements, each completely defining one tube station.Each tube station used in the map MUST have exactly one defining
<station>element. Even if a station is served by more than one line, there MUST NOT be more than one<station>element for this station.Each
<station>element MUST have anidattribute, anameattribute, alineattribute and alinkattribute. It MAY have another_linkattribute. It MAY also have other attributes, which will in general be ignored by Map::Tube.The value of the
idattribute SHOULD consist of 7-bit printing characters without spaces. It MUST NOT contain a comma (",") or a colon (":"). In general, it will be a rather short string, but this is not required. EachidMUST be unique among the stations. Stationids are case-sensitive, so two station'sids MAY differ only in case (although this is not considered good practice). Any stationidSHOULD not occur also as a lineid.ids are usually not seen by end users.The
nameattribute MAY be any string. It SHOULD be unique among the stations (but it MAY be the same as a linename). Typically, end users will interact with these names, so this should be kept in mind when choosing names.The value of the
lineattribute MUST be a list of one or more line-specs. If there is more than one line-spec, they MUST be separated by commas (","). Lines MUST NOT be named more than once in any station'slineattribute.A line-spec MUST consist of a defined line
id, which MAY be followed by a colon (":") and a positive integer. The lineidsignifies a line serving this station. If the extended form is used, the integer signifies the position of this station on the line. Typically, the station at one (arbitrarily chosen) end will be denoted by 1, the next one by 2, etc. The numbers do not have to be consecutive, but they MUST be in strictly increasing order.Each line MUST either throughout use the extended line-spec form or the short form. Any given line MUST NOT use the extended form at some stations and the short form at others. However, different lines MAY differ in this respect from each other.
The value of the
linkattribute MUST be a list of one or more defined stationids. If there is more than one station, they MUST be separated by commas (","). Stations MUST NOT be named more than once in any station'slinkattribute.For each line named by a station's
lineattribute, at least one of the stations named in itslinkatttribute MUST also name this line in itslineattribute.For each station named in a station's
linkattribute there MUST be at least one line named in both these stations'lineattributes.If a station (say, with
idA) names a station (say, withidB) in itslinkattribute and vice-versa, this is called a bidirectional link, otherwise it is called a unidirectional link.The value of the
other_linkattribute, if present, MUST be a list of one or more other-link-specs. If there is more than oneother-link-spec, they MUST be separated by commas (","). An other-link-spec describes a non-tube connection between two different stations, usually through some passageway, tunnel or escalator link.An
other-link-specMUST consist of an identifier, followed by a colon (":"), followed by theidof a defined station. The identifier doubles as both an id (in that it uniquely identifies an entity) and a name (in that it may be displayed to end users). As such, it SHOULD follow the rules for lineids. The identifier MAY be theidof a defined line. Any lineidMUST NOT come up both in some station'slineattribute and in some (possibly different) station'sother_linkattribute.A station MAY be named both in another station's
linkand itsother_linkattributes, although this is unusual.For each
other-link-specat some station (say, withidA) that names another station (say, withidB), there MUST be a correspondingother-link-specat station B that uses the same identifier and names station A. (In other words,other-link-specs MUST come in pairs, making all such connections bidirectional).A station MUST NOT name itself in its
linkattribute nor in itsother_linkatttribute.Usually, lines are connected in the sense that any station on a given line is reachable from each other station on the same line. However, this is not required.
Usually, maps are connected in the sense that any station on the map is reachable from each other station on the map. However, this is not required.
As indicated above, maps MAY also use attributes other than those mentioned above. These will in general be ignored by most Map::Tube software. However, your software may make use of the additional data either for its own purposes, or it may make these attributes usable for Map::Tube. E.g., Map::Tube::Beijing and Map::Tube::Hongkong (q.v.) both use additional
name_altattributes in order to provide not only Latin-script versions of the names but, as an alternative, also Han (Chinese script) names. The version to use is decided when the Map::Tube object is instantiated. (This could also be used to specify alternative station names in n-lingual areas (where n > 1).
WORK WITH A MAP
You would need Map::Tube v3.22 or above to be able to support the JSON format.
The following code manages map data in XML format:
package Sample::Map;
use Moo;
use namespace::clean;
has xml => (is => 'ro', default => sub { 'sample.xml' });
with 'Map::Tube';
package main;
use strict; use warnings;
my $map = Sample::Map->new;
print $map->get_shortest_route('A', 'D');In order to support map data in JSON format, just replace the line below:
has xml => (is => 'ro', default => sub { 'sample.xml' });with
has json => (is => 'ro', default => sub { 'sample.json' });MAP GRAPH
To print the entire map or just a particular line map, just install the plugin Map::Tube::Plugin::Graph and you have all the tools to create map image.
use strict; use warnings;
use MIME::Base64;
use Sample::Map;
my $map = Sample::Map->new;
my $name = $map->name;
open(my $MAP_IMAGE, ">$name.png");
binmode($MAP_IMAGE);
print $MAP_IMAGE decode_base64($map->as_image);
close($MAP_IMAGE);FUZZY FIND
To enable the fuzzy search ability to the sample map, you would need to install Map::Tube::Plugin::FuzzyFind and you have everything you need to perform the task.
use strict; use warnings;
use Sample::Map;
my $map = Sample::Map->new;
print 'Line contains: ', $map->fuzzy_find(search => 'a', object => 'lines');VALIDATE MAP
There is a handy package Test::Map::Tube that can help you in testing the basic map structure and functionalities.
use strict; use warnings;
use Test::More;
my $min_ver = 0.09;
eval "use Test::Map::Tube $min_ver tests => 2";
plan skip_all => "Test::Map::Tube $min_ver required" if $@;
use Sample::Map;
my $map = Sample::Map->new;
ok_map($map);
ok_map_functions($map);SEARCH ALGORITHM
Map::Tube uses Dijkstra's Algorithm, invented and published by computer science pioneer Edsger W. Dijkstra in the 1950s.
Let us take this sample map.
1 -------- 2
/ \ / \
/ \ / \
0 ------ 6 ------ 3
\ / \ /
\ / \ /
5 -------- 4We would build a table initially as follows:
+--------+---------------+
| Vertex | Path | Length |
+--------+------+--------+
| 0 | - | INF |
| 1 | - | INF |
| 2 | - | INF |
| 3 | - | INF |
| 4 | - | INF |
| 5 | - | INF |
| 6 | - | INF |
+--------+------+--------+In the table, the index on the left represents the vertex we are going to (for convenience, we will assume that we are starting at vertex 0). The Path field tells us which vertex precedes us in the path. The Length field is the length of the path from the starting vertex to that vertex, which we initialize to INFinity under the assumption that there is no path unless we find one, in which case the length will be less than infinity.
We begin by indicating that 0 can reach itself with a path of length 0. This is better than infinity, so we replace INF with 0 in the Length column, and we also place a 0 in the Path column. Now we look at 0's neighbors. All three of 0's neighbors 1, 5, and 6 can be reached from 0 with a path of length 1 (1 + the length of the path to 0, which is 0), and for all three of them this is better than INFinity, so we update their Path and Length fields and then enqueue them because we will have to look at their neighbors next.
We dequeue 1, and look at its neighbors 0, 2, and 6. The path through vertex 1 to each of those vertices would have a length of 2 (1 + the length of the path to 1, which is 1). For 0 and 6 this is worse than what is already in their Length field so we will do nothing for them. For 2, the path of length 2 is better than infinity, so we will put 2 in its Length field and 1 in its Path field, since it came from 1, and then we will enqueue it so we can eventually look at its neighbors if necessary.
We dequeue the 5 and look at its neighbors 0, 4, and 6. The path through vertex 5 to each of those vertices would have a length of 2 (1 + the length of the path to 5, which is 1). For 0 and 6, this is worse than what is already in their Length field, so we will do nothing for them. For 4, the path of length 2 is better than infinity, so we will put 2 in its Length field and 5 in its Path field, since it came from 5, and then we will enqueue it so we can eventually look at its neighbors if necessary.
Next we dequeue the 6, which shares an edge with each of the other six vertices. The path through 6 to any of these vertices would have a length of 2, but only vertex 3 currently has a higher Length (infinity), so we will update 3's fields and enqueue it.
Of the remaining items in the queue the path through them to their neighbors will all have a length of 3, since they all have a length of 2, which will be worse than the values that are already in the Length fields of all the vertices, so we will not make any more changes to the table. The result is the following table:
+--------+---------------+
| Vertex | Path | Length |
+--------+------+--------+
| 0 | 0 | 0 |
| 1 | 0 | 1 |
| 2 | 1 | 2 |
| 3 | 6 | 2 |
| 4 | 5 | 2 |
| 5 | 0 | 1 |
| 6 | 0 | 1 |
+--------+------+--------+Now if we need to know how far away a vertex is from vertex 0, we can look it up in the table.
TEAM
Gisbert W Selke (GWS)
Author of maps like Glasgow, Lyon etc. Also the creator of the wonderful Fuzzy Find plugin.
Michal Spacek (SKIM)
Author of most of the maps, e.g. Moscow, Kiev, Warsaw, Sofia etc. He is the top in the leader board of map authorship. He has been the source behind many nice features that we have.
Slaven Rezic (SREZIC)
Author of maps like Berlin.
AUTHOR
Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>
REPOSITORY
https://github.com/manwar/Map-Tube
BUGS
Please report any bugs or feature requests to bug-map-tube at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Map-Tube. I will be notified and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Map::Tube::CookbookYou can also look for information at:
BUG Report
CPAN Ratings
Search MetaCPAN
LICENSE AND COPYRIGHT
Copyright (C) 2010 - 2025 Mohammad Sajid Anwar.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.