This file is indexed.

/usr/share/doc/python3-munkres/html/munkres-module.html is in python3-munkres 1.0.7-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>munkres</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://software.clapper.org/munkres/">Munkres</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;munkres
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="munkres-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module munkres</h1><p class="nomargin-top"><span class="codelink"><a href="munkres-pysrc.html">source&nbsp;code</a></span></p>
<div class="rst-section" id="rst-introduction">
<h1 class="heading">Introduction</h1>
<p>The Munkres module provides an implementation of the Munkres algorithm
(also called the Hungarian algorithm or the Kuhn-Munkres algorithm),
useful for solving the Assignment Problem.</p>
</div>
<div class="rst-section" id="rst-assignment-problem">
<h1 class="heading">Assignment Problem</h1>
<p>Let <em>C</em> be an <em>n</em>x<em>n</em> matrix representing the costs of each of <em>n</em> workers
to perform any of <em>n</em> jobs. The assignment problem is to assign jobs to
workers in a way that minimizes the total cost. Since each worker can perform
only one job and each job can be assigned to only one worker the assignments
represent an independent set of the matrix <em>C</em>.</p>
<p>One way to generate the optimal set is to create all permutations of
the indexes necessary to traverse the matrix so that no row and column
are used more than once. For instance, given this matrix (expressed in
Python):</p>
<pre class="rst-literal-block">
matrix = [[5, 9, 1],
          [10, 3, 2],
          [8, 7, 4]]
</pre>
<p>You could use this code to generate the traversal indexes:</p>
<pre class="rst-literal-block">
def permute(a, results):
    if len(a) == 1:
        results.insert(len(results), a)

    else:
        for i in range(0, len(a)):
            element = a[i]
            a_copy = [a[j] for j in range(0, len(a)) if j != i]
            subresults = []
            permute(a_copy, subresults)
            for subresult in subresults:
                result = [element] + subresult
                results.insert(len(results), result)

results = []
permute(range(len(matrix)), results) # [0, 1, 2] for a 3x3 matrix
</pre>
<p>After the call to permute(), the results matrix would look like this:</p>
<pre class="rst-literal-block">
[[0, 1, 2],
 [0, 2, 1],
 [1, 0, 2],
 [1, 2, 0],
 [2, 0, 1],
 [2, 1, 0]]
</pre>
<p>You could then use that index matrix to loop over the original cost matrix
and calculate the smallest cost of the combinations:</p>
<pre class="rst-literal-block">
n = len(matrix)
minval = sys.maxsize
for row in range(n):
    cost = 0
    for col in range(n):
        cost += matrix[row][col]
    minval = min(cost, minval)

print minval
</pre>
<p>While this approach works fine for small matrices, it does not scale. It
executes in O(<em>n</em>!) time: Calculating the permutations for an <em>n</em>x<em>n</em>
matrix requires <em>n</em>! operations. For a 12x12 matrix, that's 479,001,600
traversals. Even if you could manage to perform each traversal in just one
millisecond, it would still take more than 133 hours to perform the entire
traversal. A 20x20 matrix would take 2,432,902,008,176,640,000 operations. At
an optimistic millisecond per operation, that's more than 77 million years.</p>
<p>The Munkres algorithm runs in O(<em>n</em>^3) time, rather than O(<em>n</em>!). This
package provides an implementation of that algorithm.</p>
<p>This version is based on
<a class="rst-reference external" href="http://www.public.iastate.edu/~ddoty/HungarianAlgorithm.html" target="_top">http://www.public.iastate.edu/~ddoty/HungarianAlgorithm.html</a>.</p>
<p>This version was written for Python by Brian Clapper from the (Ada) algorithm
at the above web site. (The <tt class="rst-docutils literal"><span class="pre">Algorithm::Munkres</span></tt> Perl version, in CPAN, was
clearly adapted from the same web site.)</p>
</div>
<div class="rst-section" id="rst-usage">
<h1 class="heading">Usage</h1>
<p>Construct a Munkres object:</p>
<pre class="rst-literal-block">
from munkres import Munkres

m = Munkres()
</pre>
<p>Then use it to compute the lowest cost assignment from a cost matrix. Here's
a sample program:</p>
<pre class="rst-literal-block">
from munkres import Munkres, print_matrix

matrix = [[5, 9, 1],
          [10, 3, 2],
          [8, 7, 4]]
m = Munkres()
indexes = m.compute(matrix)
print_matrix(matrix, msg='Lowest cost through this matrix:')
total = 0
for row, column in indexes:
    value = matrix[row][column]
    total += value
    print '(%d, %d) -&gt; %d' % (row, column, value)
print 'total cost: %d' % total
</pre>
<p>Running that program produces:</p>
<pre class="rst-literal-block">
Lowest cost through this matrix:
[5, 9, 1]
[10, 3, 2]
[8, 7, 4]
(0, 0) -&gt; 5
(1, 1) -&gt; 3
(2, 2) -&gt; 4
total cost=12
</pre>
<p>The instantiated Munkres object can be used multiple times on different
matrices.</p>
</div>
<div class="rst-section" id="rst-non-square-cost-matrices">
<h1 class="heading">Non-square Cost Matrices</h1>
<p>The Munkres algorithm assumes that the cost matrix is square. However, it's
possible to use a rectangular matrix if you first pad it with 0 values to make
it square. This module automatically pads rectangular cost matrices to make
them square.</p>
<p>Notes:</p>
<ul class="rst-simple">
<li>The module operates on a <em>copy</em> of the caller's matrix, so any padding will
not be seen by the caller.</li>
<li>The cost matrix must be rectangular or square. An irregular matrix will
<em>not</em> work.</li>
</ul>
</div>
<div class="rst-section" id="rst-calculating-profit-rather-than-cost">
<h1 class="heading">Calculating Profit, Rather than Cost</h1>
<p>The cost matrix is just that: A cost matrix. The Munkres algorithm finds
the combination of elements (one from each row and column) that results in
the smallest cost. It's also possible to use the algorithm to maximize
profit. To do that, however, you have to convert your profit matrix to a
cost matrix. The simplest way to do that is to subtract all elements from a
large value. For example:</p>
<pre class="rst-literal-block">
from munkres import Munkres, print_matrix

matrix = [[5, 9, 1],
          [10, 3, 2],
          [8, 7, 4]]
cost_matrix = []
for row in matrix:
    cost_row = []
    for col in row:
        cost_row += [sys.maxsize - col]
    cost_matrix += [cost_row]

m = Munkres()
indexes = m.compute(cost_matrix)
print_matrix(matrix, msg='Highest profit through this matrix:')
total = 0
for row, column in indexes:
    value = matrix[row][column]
    total += value
    print '(%d, %d) -&gt; %d' % (row, column, value)

print 'total profit=%d' % total
</pre>
<p>Running that program produces:</p>
<pre class="rst-literal-block">
Highest profit through this matrix:
[5, 9, 1]
[10, 3, 2]
[8, 7, 4]
(0, 1) -&gt; 9
(1, 0) -&gt; 10
(2, 2) -&gt; 4
total profit=23
</pre>
<p>The <tt class="rst-docutils literal">munkres</tt> module provides a convenience method for creating a cost
matrix from a profit matrix. Since it doesn't know whether the matrix contains
floating point numbers, decimals, or integers, you have to provide the
conversion function; but the convenience method takes care of the actual
creation of the cost matrix:</p>
<pre class="rst-literal-block">
import munkres

cost_matrix = munkres.make_cost_matrix(matrix,
                                       lambda cost: sys.maxsize - cost)
</pre>
<p>So, the above profit-calculation program can be recast as:</p>
<pre class="rst-literal-block">
from munkres import Munkres, print_matrix, make_cost_matrix

matrix = [[5, 9, 1],
          [10, 3, 2],
          [8, 7, 4]]
cost_matrix = make_cost_matrix(matrix, lambda cost: sys.maxsize - cost)
m = Munkres()
indexes = m.compute(cost_matrix)
print_matrix(matrix, msg='Lowest cost through this matrix:')
total = 0
for row, column in indexes:
    value = matrix[row][column]
    total += value
    print '(%d, %d) -&gt; %d' % (row, column, value)
print 'total profit=%d' % total
</pre>
</div>
<div class="rst-section" id="rst-references">
<h1 class="heading">References</h1>
<ol class="rst-arabic simple">
<li><a class="rst-reference external" href="http://www.public.iastate.edu/~ddoty/HungarianAlgorithm.html" target="_top">http://www.public.iastate.edu/~ddoty/HungarianAlgorithm.html</a></li>
<li>Harold W. Kuhn. The Hungarian Method for the assignment problem.
<em>Naval Research Logistics Quarterly</em>, 2:83-97, 1955.</li>
<li>Harold W. Kuhn. Variants of the Hungarian method for assignment
problems. <em>Naval Research Logistics Quarterly</em>, 3: 253-258, 1956.</li>
<li>Munkres, J. Algorithms for the Assignment and Transportation Problems.
<em>Journal of the Society of Industrial and Applied Mathematics</em>,
5(1):32-38, March, 1957.</li>
<li><a class="rst-reference external" href="http://en.wikipedia.org/wiki/Hungarian_algorithm" target="_top">http://en.wikipedia.org/wiki/Hungarian_algorithm</a></li>
</ol>
</div>
<div class="rst-section" id="rst-copyright-and-license">
<h1 class="heading">Copyright and License</h1>
<p>This software is released under a BSD license, adapted from
&lt;<a class="rst-reference external" href="http://opensource.org/licenses/bsd-license.php" target="_top">http://opensource.org/licenses/bsd-license.php</a>&gt;</p>
<p>Copyright (c) 2008 Brian M. Clapper
All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:</p>
<ul class="rst-simple">
<li>Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.</li>
<li>Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.</li>
<li>Neither the name &quot;clapper.org&quot; nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.</li>
</ul>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.</p>
</div>

<hr />
<div class="fields">      <p><strong>Version:</strong>
        1.0.7
      </p>
      <p><strong>Author:</strong>
        Brian Clapper, bmc@clapper.org
      </p>
      <p><strong>Copyright:</strong>
        (c) 2008 Brian M. Clapper
      </p>
      <p><strong>License:</strong>
        BSD-style license
      </p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="munkres.Munkres-class.html" class="summary-name">Munkres</a><br />
      Calculate the Munkres solution to the classical assignment problem.
See the module documentation for usage.
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list of lists</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="munkres-module.html#make_cost_matrix" class="summary-sig-name">make_cost_matrix</a>(<span class="summary-sig-arg">profit_matrix</span>,
        <span class="summary-sig-arg">inversion_function</span>)</span><br />
      Create a cost matrix from a profit matrix by calling
'inversion_function' to invert each value. The inversion
function must take one numeric argument (of any type) and return
another numeric argument which is presumed to be the cost inverse
of the original profit.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="munkres-pysrc.html#make_cost_matrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="munkres-module.html#print_matrix" class="summary-sig-name" onclick="show_private();">print_matrix</a>(<span class="summary-sig-arg">matrix</span>,
        <span class="summary-sig-arg">msg</span>=<span class="summary-sig-default">None</span>)</span><br />
      Convenience function: Displays the contents of a matrix of integers.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="munkres-pysrc.html#print_matrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__url__"></a><span class="summary-name">__url__</span> = <code title="'http://software.clapper.org/munkres/'"><code class="variable-quote">'</code><code class="variable-string">http://software.clapper.org/munkres/</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="make_cost_matrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">make_cost_matrix</span>(<span class="sig-arg">profit_matrix</span>,
        <span class="sig-arg">inversion_function</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="munkres-pysrc.html#make_cost_matrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Create a cost matrix from a profit matrix by calling
'inversion_function' to invert each value. The inversion
function must take one numeric argument (of any type) and return
another numeric argument which is presumed to be the cost inverse
of the original profit.</p>
<p>This is a static method. Call it like this:</p>
<pre class="py-doctest">
cost_matrix = Munkres.make_cost_matrix(matrix, inversion_func)</pre>
<p>For example:</p>
<pre class="py-doctest">
cost_matrix = Munkres.make_cost_matrix(matrix, <span class="py-keyword">lambda</span> x : sys.maxsize - x)</pre>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>profit_matrix</code></strong> (list of lists) - The matrix to convert from a profit to a cost matrix</li>
        <li><strong class="pname"><code>inversion_function</code></strong> (function) - The function to use to invert each entry in the profit matrix</li>
    </ul></dd>
    <dt>Returns: list of lists</dt>
        <dd>The converted matrix</dd>
  </dl>
</td></tr></table>
</div>
<a name="print_matrix"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">print_matrix</span>(<span class="sig-arg">matrix</span>,
        <span class="sig-arg">msg</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="munkres-pysrc.html#print_matrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  Convenience function: Displays the contents of a matrix of integers.
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>matrix</code></strong> (list of lists) - Matrix to print</li>
        <li><strong class="pname"><code>msg</code></strong> (str) - Optional message to print before displaying the matrix</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://software.clapper.org/munkres/">Munkres</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    on Sat Jul  4 05:44:34 2015
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>