Skip to content

Commit 86657d3

Browse files
cicirellocicirello
authored
Merge pull request #75 from cicirello/create-pull-request/docs
Automated API website updates.
2 parents 62701a6 + be311a7 commit 86657d3

30 files changed

+229
-114
lines changed

Diff for: ‎docs/api/index-all.html

+23-67
Original file line numberDiff line numberDiff line change
@@ -566,9 +566,7 @@ <h2 class="title">D</h2>
566566
<div class="block">Measures the distance between two permutations.</div>
567567
</dd>
568568
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ScrambleDistance.html#distance(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distance(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/ScrambleDistance.html" title="class in org.cicirello.permutations.distance">ScrambleDistance</a></dt>
569-
<dd>
570-
<div class="block">Measures the distance between two permutations.</div>
571-
</dd>
569+
<dd>&nbsp;</dd>
572570
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/SquaredDeviationDistance.html#distance(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distance(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/SquaredDeviationDistance.html" title="class in org.cicirello.permutations.distance">SquaredDeviationDistance</a></dt>
573571
<dd>
574572
<div class="block">Measures the distance between two permutations.</div>
@@ -663,7 +661,8 @@ <h2 class="title">D</h2>
663661
</dd>
664662
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicIndependentDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/CyclicIndependentDistance.html" title="class in org.cicirello.permutations.distance">CyclicIndependentDistance</a></dt>
665663
<dd>
666-
<div class="block">Measures the distance between two permutations</div>
664+
<div class="block">Measures the distance between two permutations, with cyclic independence:
665+
distance = min_{i in [0,N)} distance(p1,rotate(p2,i))</div>
667666
</dd>
668667
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicIndependentDistanceDouble.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/CyclicIndependentDistanceDouble.html" title="class in org.cicirello.permutations.distance">CyclicIndependentDistanceDouble</a></dt>
669668
<dd>
@@ -672,7 +671,8 @@ <h2 class="title">D</h2>
672671
</dd>
673672
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicReversalIndependentDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/CyclicReversalIndependentDistance.html" title="class in org.cicirello.permutations.distance">CyclicReversalIndependentDistance</a></dt>
674673
<dd>
675-
<div class="block">Measures the distance between two permutations</div>
674+
<div class="block">Measures the distance between two permutations, with cyclic and reversal independence:
675+
distance = min_{i in [0,N)} { distance(p1,rotate(p2,i)), distance(p1,rotate(reverse(p2),i)) }</div>
676676
</dd>
677677
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicReversalIndependentDistanceDouble.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/CyclicReversalIndependentDistanceDouble.html" title="class in org.cicirello.permutations.distance">CyclicReversalIndependentDistanceDouble</a></dt>
678678
<dd>
@@ -689,15 +689,16 @@ <h2 class="title">D</h2>
689689
</dd>
690690
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/EditDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/EditDistance.html" title="class in org.cicirello.permutations.distance">EditDistance</a></dt>
691691
<dd>
692-
<div class="block">Measures the distance between two permutations</div>
692+
<div class="block">Measures the distance between two permutations.</div>
693693
</dd>
694694
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurerDouble.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in interface org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/PermutationDistanceMeasurerDouble.html" title="interface in org.cicirello.permutations.distance">PermutationDistanceMeasurerDouble</a></dt>
695695
<dd>
696696
<div class="block">Measures the distance between two permutations</div>
697697
</dd>
698698
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ReversalIndependentDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/ReversalIndependentDistance.html" title="class in org.cicirello.permutations.distance">ReversalIndependentDistance</a></dt>
699699
<dd>
700-
<div class="block">Measures the distance between two permutations</div>
700+
<div class="block">Measures the distance between two permutations, with reversal independence:
701+
distance = min { distance(p1,p2), distance(p1,reverse(p2)) }</div>
701702
</dd>
702703
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ReversalIndependentDistanceDouble.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef(Permutation, Permutation)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/ReversalIndependentDistanceDouble.html" title="class in org.cicirello.permutations.distance">ReversalIndependentDistanceDouble</a></dt>
703704
<dd>
@@ -923,94 +924,49 @@ <h2 class="title">M</h2>
923924
represented as 2-D Java arrays.</div>
924925
</dd>
925926
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/AcyclicEdgeDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/AcyclicEdgeDistance.html" title="class in org.cicirello.permutations.distance">AcyclicEdgeDistance</a></dt>
926-
<dd>
927-
<div class="block">Computes the maximum possible distance between permutations
928-
of a specified length.</div>
929-
</dd>
927+
<dd>&nbsp;</dd>
930928
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/BlockInterchangeDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/BlockInterchangeDistance.html" title="class in org.cicirello.permutations.distance">BlockInterchangeDistance</a></dt>
931-
<dd>
932-
<div class="block">Computes the maximum possible distance between permutations
933-
of a specified length.</div>
934-
</dd>
929+
<dd>&nbsp;</dd>
935930
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicEdgeDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/CyclicEdgeDistance.html" title="class in org.cicirello.permutations.distance">CyclicEdgeDistance</a></dt>
936-
<dd>
937-
<div class="block">Computes the maximum possible distance between permutations
938-
of a specified length.</div>
939-
</dd>
931+
<dd>&nbsp;</dd>
940932
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicRTypeDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/CyclicRTypeDistance.html" title="class in org.cicirello.permutations.distance">CyclicRTypeDistance</a></dt>
941-
<dd>
942-
<div class="block">Computes the maximum possible distance between permutations
943-
of a specified length.</div>
944-
</dd>
933+
<dd>&nbsp;</dd>
945934
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/DeviationDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/DeviationDistance.html" title="class in org.cicirello.permutations.distance">DeviationDistance</a></dt>
946-
<dd>
947-
<div class="block">Computes the maximum possible distance between permutations
948-
of a specified length.</div>
949-
</dd>
935+
<dd>&nbsp;</dd>
950936
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ExactMatchDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/ExactMatchDistance.html" title="class in org.cicirello.permutations.distance">ExactMatchDistance</a></dt>
951-
<dd>
952-
<div class="block">Computes the maximum possible distance between permutations
953-
of a specified length.</div>
954-
</dd>
937+
<dd>&nbsp;</dd>
955938
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/InterchangeDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/InterchangeDistance.html" title="class in org.cicirello.permutations.distance">InterchangeDistance</a></dt>
956-
<dd>
957-
<div class="block">Computes the maximum possible distance between permutations
958-
of a specified length.</div>
959-
</dd>
939+
<dd>&nbsp;</dd>
960940
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/KendallTauDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/KendallTauDistance.html" title="class in org.cicirello.permutations.distance">KendallTauDistance</a></dt>
961-
<dd>
962-
<div class="block">Computes the maximum possible distance between permutations
963-
of a specified length.</div>
964-
</dd>
941+
<dd>&nbsp;</dd>
965942
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/LeeDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/LeeDistance.html" title="class in org.cicirello.permutations.distance">LeeDistance</a></dt>
966-
<dd>
967-
<div class="block">Computes the maximum possible distance between permutations
968-
of a specified length.</div>
969-
</dd>
943+
<dd>&nbsp;</dd>
970944
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurer.html#max(int)">max(int)</a></span> - Method in interface org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurer.html" title="interface in org.cicirello.permutations.distance">NormalizedPermutationDistanceMeasurer</a></dt>
971945
<dd>
972946
<div class="block">Computes the maximum possible distance between permutations
973947
of a specified length.</div>
974948
</dd>
975949
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ReinsertionDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/ReinsertionDistance.html" title="class in org.cicirello.permutations.distance">ReinsertionDistance</a></dt>
976-
<dd>
977-
<div class="block">Computes the maximum possible distance between permutations
978-
of a specified length.</div>
979-
</dd>
950+
<dd>&nbsp;</dd>
980951
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ReversalDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/ReversalDistance.html" title="class in org.cicirello.permutations.distance">ReversalDistance</a></dt>
981952
<dd>
982953
<div class="block">Computes the maximum possible distance between permutations
983954
of a specified length.</div>
984955
</dd>
985956
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/RTypeDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/RTypeDistance.html" title="class in org.cicirello.permutations.distance">RTypeDistance</a></dt>
986-
<dd>
987-
<div class="block">Computes the maximum possible distance between permutations
988-
of a specified length.</div>
989-
</dd>
957+
<dd>&nbsp;</dd>
990958
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ScrambleDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/ScrambleDistance.html" title="class in org.cicirello.permutations.distance">ScrambleDistance</a></dt>
991-
<dd>
992-
<div class="block">Computes the maximum possible distance between permutations
993-
of a specified length.</div>
994-
</dd>
959+
<dd>&nbsp;</dd>
995960
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/SquaredDeviationDistance.html#max(int)">max(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/SquaredDeviationDistance.html" title="class in org.cicirello.permutations.distance">SquaredDeviationDistance</a></dt>
996-
<dd>
997-
<div class="block">Computes the maximum possible distance between permutations
998-
of a specified length.</div>
999-
</dd>
961+
<dd>&nbsp;</dd>
1000962
<dt><span class="memberNameLink"><a href="org/cicirello/math/la/JacobiDiagonalization.html#MAX_ITERATIONS">MAX_ITERATIONS</a></span> - Static variable in class org.cicirello.math.la.<a href="org/cicirello/math/la/JacobiDiagonalization.html" title="class in org.cicirello.math.la">JacobiDiagonalization</a></dt>
1001963
<dd>
1002964
<div class="block">Default max number of iterations.</div>
1003965
</dd>
1004966
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/DeviationDistanceNormalized.html#maxf(int)">maxf(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/DeviationDistanceNormalized.html" title="class in org.cicirello.permutations.distance">DeviationDistanceNormalized</a></dt>
1005-
<dd>
1006-
<div class="block">Computes the maximum possible distance between permutations
1007-
of a specified length.</div>
1008-
</dd>
967+
<dd>&nbsp;</dd>
1009968
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/DeviationDistanceNormalized2005.html#maxf(int)">maxf(int)</a></span> - Method in class org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/DeviationDistanceNormalized2005.html" title="class in org.cicirello.permutations.distance">DeviationDistanceNormalized2005</a></dt>
1010-
<dd>
1011-
<div class="block">Computes the maximum possible distance between permutations
1012-
of a specified length.</div>
1013-
</dd>
969+
<dd>&nbsp;</dd>
1014970
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurerDouble.html#maxf(int)">maxf(int)</a></span> - Method in interface org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurerDouble.html" title="interface in org.cicirello.permutations.distance">NormalizedPermutationDistanceMeasurerDouble</a></dt>
1015971
<dd>
1016972
<div class="block">Computes the maximum possible distance between permutations

Diff for: ‎docs/api/org/cicirello/permutations/class-use/Permutation.html

+8-7
Original file line numberDiff line numberDiff line change
@@ -391,9 +391,7 @@ <h3>Uses of <a href="../Permutation.html" title="class in org.cicirello.permutat
391391
<td class="colFirst"><code>int</code></td>
392392
<th class="colSecond" scope="row"><span class="typeNameLabel">ScrambleDistance.</span><code><span class="memberNameLink"><a href="../distance/ScrambleDistance.html#distance(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distance</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p1,
393393
<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p2)</code></th>
394-
<td class="colLast">
395-
<div class="block">Measures the distance between two permutations.</div>
396-
</td>
394+
<td class="colLast">&nbsp;</td>
397395
</tr>
398396
<tr class="rowColor">
399397
<td class="colFirst"><code>int</code></td>
@@ -408,7 +406,8 @@ <h3>Uses of <a href="../Permutation.html" title="class in org.cicirello.permutat
408406
<th class="colSecond" scope="row"><span class="typeNameLabel">CyclicIndependentDistance.</span><code><span class="memberNameLink"><a href="../distance/CyclicIndependentDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p1,
409407
<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p2)</code></th>
410408
<td class="colLast">
411-
<div class="block">Measures the distance between two permutations</div>
409+
<div class="block">Measures the distance between two permutations, with cyclic independence:
410+
distance = min_{i in [0,N)} distance(p1,rotate(p2,i))</div>
412411
</td>
413412
</tr>
414413
<tr class="rowColor">
@@ -425,7 +424,8 @@ <h3>Uses of <a href="../Permutation.html" title="class in org.cicirello.permutat
425424
<th class="colSecond" scope="row"><span class="typeNameLabel">CyclicReversalIndependentDistance.</span><code><span class="memberNameLink"><a href="../distance/CyclicReversalIndependentDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p1,
426425
<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p2)</code></th>
427426
<td class="colLast">
428-
<div class="block">Measures the distance between two permutations</div>
427+
<div class="block">Measures the distance between two permutations, with cyclic and reversal independence:
428+
distance = min_{i in [0,N)} { distance(p1,rotate(p2,i)), distance(p1,rotate(reverse(p2),i)) }</div>
429429
</td>
430430
</tr>
431431
<tr class="rowColor">
@@ -458,7 +458,7 @@ <h3>Uses of <a href="../Permutation.html" title="class in org.cicirello.permutat
458458
<th class="colSecond" scope="row"><span class="typeNameLabel">EditDistance.</span><code><span class="memberNameLink"><a href="../distance/EditDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p1,
459459
<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p2)</code></th>
460460
<td class="colLast">
461-
<div class="block">Measures the distance between two permutations</div>
461+
<div class="block">Measures the distance between two permutations.</div>
462462
</td>
463463
</tr>
464464
<tr class="rowColor">
@@ -474,7 +474,8 @@ <h3>Uses of <a href="../Permutation.html" title="class in org.cicirello.permutat
474474
<th class="colSecond" scope="row"><span class="typeNameLabel">ReversalIndependentDistance.</span><code><span class="memberNameLink"><a href="../distance/ReversalIndependentDistance.html#distancef(org.cicirello.permutations.Permutation,org.cicirello.permutations.Permutation)">distancef</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p1,
475475
<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p2)</code></th>
476476
<td class="colLast">
477-
<div class="block">Measures the distance between two permutations</div>
477+
<div class="block">Measures the distance between two permutations, with reversal independence:
478+
distance = min { distance(p1,p2), distance(p1,reverse(p2)) }</div>
478479
</td>
479480
</tr>
480481
<tr class="rowColor">

0 commit comments

Comments
 (0)