Skip to content

Commit 99a26a3

Browse files
cicirellocicirello
committed
updated docs
1 parent 357ab5b commit 99a26a3

File tree

61 files changed

+915
-230
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+915
-230
lines changed

‎docs/api/allclasses-frame.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:31 EDT 2019 -->
66
<title>All Classes (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

‎docs/api/allclasses-noframe.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:31 EDT 2019 -->
66
<title>All Classes (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

‎docs/api/constant-values.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:30 EDT 2019 -->
66
<title>Constant Field Values (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

‎docs/api/deprecated-list.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:31 EDT 2019 -->
66
<title>Deprecated List (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

‎docs/api/help-doc.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:31 EDT 2019 -->
66
<title>API Help (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

‎docs/api/index-all.html‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:30 EDT 2019 -->
66
<title>Index (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -594,13 +594,13 @@ <h2 class="title">M</h2>
594594
</dd>
595595
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicIndependentDistance.html#max-int-">max(int)</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>
596596
<dd>
597-
<div class="block">Computes the maximum possible distance between permutations
598-
of a specified length.</div>
597+
<div class="block">The max method is unsupported when computing
598+
distance with cyclic independence.</div>
599599
</dd>
600600
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicReversalIndependentDistance.html#max-int-">max(int)</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>
601601
<dd>
602-
<div class="block">Computes the maximum possible distance between permutations
603-
of a specified length.</div>
602+
<div class="block">The max method is unsupported when computing
603+
distance with cyclic and reversal independence.</div>
604604
</dd>
605605
<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>
606606
<dd>
@@ -649,8 +649,8 @@ <h2 class="title">M</h2>
649649
</dd>
650650
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ReversalIndependentDistance.html#max-int-">max(int)</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>
651651
<dd>
652-
<div class="block">Computes the maximum possible distance between permutations
653-
of a specified length.</div>
652+
<div class="block">The max method is unsupported when computing
653+
distance with reversal independence.</div>
654654
</dd>
655655
<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>
656656
<dd>
@@ -673,13 +673,13 @@ <h2 class="title">M</h2>
673673
</dd>
674674
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicIndependentDistanceDouble.html#maxf-int-">maxf(int)</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>
675675
<dd>
676-
<div class="block">Computes the maximum possible distance between permutations
677-
of a specified length.</div>
676+
<div class="block">The maxf method is unsupported when computing
677+
distance with cyclic independence.</div>
678678
</dd>
679679
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/CyclicReversalIndependentDistanceDouble.html#maxf-int-">maxf(int)</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>
680680
<dd>
681-
<div class="block">Computes the maximum possible distance between permutations
682-
of a specified length.</div>
681+
<div class="block">The maxf method is unsupported when computing
682+
distance with cyclic and reversal independence.</div>
683683
</dd>
684684
<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>
685685
<dd>
@@ -693,8 +693,8 @@ <h2 class="title">M</h2>
693693
</dd>
694694
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/EditDistance.html#maxf-int-">maxf(int)</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>
695695
<dd>
696-
<div class="block">Computes the maximum possible distance between permutations
697-
of a specified length.</div>
696+
<div class="block">The maxf method is not currently unsupported when computing
697+
edit distance.</div>
698698
</dd>
699699
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurerDouble.html#maxf-int-">maxf(int)</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>
700700
<dd>
@@ -703,8 +703,8 @@ <h2 class="title">M</h2>
703703
</dd>
704704
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/ReversalIndependentDistanceDouble.html#maxf-int-">maxf(int)</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>
705705
<dd>
706-
<div class="block">Computes the maximum possible distance between permutations
707-
of a specified length.</div>
706+
<div class="block">The maxf method is unsupported when computing
707+
distance with reversal independence.</div>
708708
</dd>
709709
<dt><span class="memberNameLink"><a href="org/cicirello/math/stats/Statistics.html#mean-int:A-">mean(int[])</a></span> - Static method in class org.cicirello.math.stats.<a href="org/cicirello/math/stats/Statistics.html" title="class in org.cicirello.math.stats">Statistics</a></dt>
710710
<dd>
@@ -721,6 +721,14 @@ <h2 class="title">M</h2>
721721
<h2 class="title">N</h2>
722722
<dl>
723723
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/PermutationIterator.html#next--">next()</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/PermutationIterator.html" title="class in org.cicirello.permutations">PermutationIterator</a></dt>
724+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurer.html#normalizedDistance-org.cicirello.permutations.Permutation-org.cicirello.permutations.Permutation-">normalizedDistance(Permutation, Permutation)</a></span> - Method in interface org.cicirello.permutations.distance.<a href="org/cicirello/permutations/distance/PermutationDistanceMeasurer.html" title="interface in org.cicirello.permutations.distance">PermutationDistanceMeasurer</a></dt>
725+
<dd>
726+
<div class="block">Measures the distance between two permutations, normalized to the interval [0.0, 1.0].</div>
727+
</dd>
728+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurerDouble.html#normalizedDistance-org.cicirello.permutations.Permutation-org.cicirello.permutations.Permutation-">normalizedDistance(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>
729+
<dd>
730+
<div class="block">Measures the distance between two permutations, normalized to the interval [0.0, 1.0].</div>
731+
</dd>
724732
</dl>
725733
<a name="I:O">
726734
<!-- -->

‎docs/api/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:31 EDT 2019 -->
66
<title>JavaPermutationTools - A Java API for computation on permutations</title>
77
<script type="text/javascript">
88
targetPage = "" + window.location.search;

‎docs/api/org/cicirello/math/la/JacobiDiagonalization.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:06 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:29 EDT 2019 -->
66
<title>JacobiDiagonalization (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../script.js"></script>
1010
</head>

‎docs/api/org/cicirello/math/la/MatrixOps.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:06 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:29 EDT 2019 -->
66
<title>MatrixOps (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../script.js"></script>
1010
</head>

‎docs/api/org/cicirello/math/la/package-frame.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_05) on Wed May 08 17:09:08 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Thu May 09 11:38:30 EDT 2019 -->
66
<title>org.cicirello.math.la (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-08">
7+
<meta name="date" content="2019-05-09">
88
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../script.js"></script>
1010
</head>

0 commit comments

Comments
 (0)