Skip to content

Commit 9065d89

Browse files
cicirellocicirello
committed
Updated docs
1 parent c13c120 commit 9065d89

File tree

66 files changed

+657
-154
lines changed

Some content is hidden

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

66 files changed

+657
-154
lines changed

‎docs/api/allclasses-frame.html

+3-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>All Classes (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -38,6 +38,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
3838
<li><a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurer.html" title="interface in org.cicirello.permutations.distance" target="classFrame"><span class="interfaceName">NormalizedPermutationDistanceMeasurer</span></a></li>
3939
<li><a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurerDouble.html" title="interface in org.cicirello.permutations.distance" target="classFrame"><span class="interfaceName">NormalizedPermutationDistanceMeasurerDouble</span></a></li>
4040
<li><a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations" target="classFrame">Permutation</a></li>
41+
<li><a href="org/cicirello/permutations/Permutation.Mechanic.html" title="class in org.cicirello.permutations" target="classFrame">Permutation.Mechanic</a></li>
4142
<li><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurer.html" title="interface in org.cicirello.permutations.distance" target="classFrame"><span class="interfaceName">PermutationDistanceMeasurer</span></a></li>
4243
<li><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurerDouble.html" title="interface in org.cicirello.permutations.distance" target="classFrame"><span class="interfaceName">PermutationDistanceMeasurerDouble</span></a></li>
4344
<li><a href="org/cicirello/permutations/PermutationIterator.html" title="class in org.cicirello.permutations" target="classFrame">PermutationIterator</a></li>

‎docs/api/allclasses-noframe.html

+3-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>All Classes (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -38,6 +38,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
3838
<li><a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurer.html" title="interface in org.cicirello.permutations.distance"><span class="interfaceName">NormalizedPermutationDistanceMeasurer</span></a></li>
3939
<li><a href="org/cicirello/permutations/distance/NormalizedPermutationDistanceMeasurerDouble.html" title="interface in org.cicirello.permutations.distance"><span class="interfaceName">NormalizedPermutationDistanceMeasurerDouble</span></a></li>
4040
<li><a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations">Permutation</a></li>
41+
<li><a href="org/cicirello/permutations/Permutation.Mechanic.html" title="class in org.cicirello.permutations">Permutation.Mechanic</a></li>
4142
<li><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurer.html" title="interface in org.cicirello.permutations.distance"><span class="interfaceName">PermutationDistanceMeasurer</span></a></li>
4243
<li><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurerDouble.html" title="interface in org.cicirello.permutations.distance"><span class="interfaceName">PermutationDistanceMeasurerDouble</span></a></li>
4344
<li><a href="org/cicirello/permutations/PermutationIterator.html" title="class in org.cicirello.permutations">PermutationIterator</a></li>

‎docs/api/constant-values.html

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>Constant Field Values (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>Deprecated List (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>API Help (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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

+36-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>Index (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -529,6 +529,10 @@ <h2 class="title">G</h2>
529529
<dd>
530530
<div class="block">Computes the inverse of the permutation.</div>
531531
</dd>
532+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.html#getInversePermutation--">getInversePermutation()</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations">Permutation</a></dt>
533+
<dd>
534+
<div class="block">Computes a Permutation that is the inverse of this Permutation.</div>
535+
</dd>
532536
</dl>
533537
<a name="I:H">
534538
<!-- -->
@@ -554,6 +558,12 @@ <h2 class="title">I</h2>
554558
<dd>
555559
<div class="block">Constructs the distance measurer as specified in the class documentation.</div>
556560
</dd>
561+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.html#invert--">invert()</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations">Permutation</a></dt>
562+
<dd>
563+
<div class="block">Inverts the Permutation, such that if p1 is the Permutation immediately
564+
prior to the call to invert, and if p2 is the Permutation immediately after
565+
the call to invert, then p1.get(i) == j iff p2.get(j) == i, for all i, j.</div>
566+
</dd>
557567
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.html#iterator--">iterator()</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations">Permutation</a></dt>
558568
<dd>
559569
<div class="block">Returns an Iterator over all Permutations the length of this Permutation.</div>
@@ -738,6 +748,10 @@ <h2 class="title">M</h2>
738748
<dd>
739749
<div class="block">Computes mean of a dataset.</div>
740750
</dd>
751+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.Mechanic.html#Mechanic--">Mechanic()</a></span> - Constructor for class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.Mechanic.html" title="class in org.cicirello.permutations">Permutation.Mechanic</a></dt>
752+
<dd>
753+
<div class="block">The default constructor can only be called by subclasses.</div>
754+
</dd>
741755
</dl>
742756
<a name="I:N">
743757
<!-- -->
@@ -868,6 +882,12 @@ <h2 class="title">P</h2>
868882
<div class="block">Initializes a permutation of the integers in the interval [0, length) based on their relative order
869883
in a permutation p.</div>
870884
</dd>
885+
<dt><a href="org/cicirello/permutations/Permutation.Mechanic.html" title="class in org.cicirello.permutations"><span class="typeNameLink">Permutation.Mechanic</span></a> - Class in <a href="org/cicirello/permutations/package-summary.html">org.cicirello.permutations</a></dt>
886+
<dd>
887+
<div class="block">The Permutation.Mechanic class provides a means of adding application-specific
888+
operations on Permutations without the need to directly alter the Permutation
889+
class.</div>
890+
</dd>
871891
<dt><a href="org/cicirello/permutations/distance/PermutationDistanceMeasurer.html" title="interface in org.cicirello.permutations.distance"><span class="typeNameLink">PermutationDistanceMeasurer</span></a> - Interface in <a href="org/cicirello/permutations/distance/package-summary.html">org.cicirello.permutations.distance</a></dt>
872892
<dd>
873893
<div class="block">Implement this interface, PermutationDistanceMeasurer, to define a distance metric for permutations.</div>
@@ -1025,6 +1045,15 @@ <h2 class="title">S</h2>
10251045
<dd>
10261046
<div class="block">Implement this interface, SequenceDistanceMeasurerDouble, to define a distance metric for sequences.</div>
10271047
</dd>
1048+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.Mechanic.html#set-org.cicirello.permutations.Permutation-int:A-">set(Permutation, int[])</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.Mechanic.html" title="class in org.cicirello.permutations">Permutation.Mechanic</a></dt>
1049+
<dd>
1050+
<div class="block">Changes the state of the Permutation according to the contents
1051+
of an array of int values.</div>
1052+
</dd>
1053+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.Mechanic.html#set-org.cicirello.permutations.Permutation-int-int-">set(Permutation, int, int)</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.Mechanic.html" title="class in org.cicirello.permutations">Permutation.Mechanic</a></dt>
1054+
<dd>
1055+
<div class="block">Changes the integer in one specific location of a Permutation.</div>
1056+
</dd>
10281057
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.html#set-int:A-">set(int[])</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations">Permutation</a></dt>
10291058
<dd>
10301059
<div class="block">Changes the state of this permutation to be identical to the elements of an array.</div>
@@ -1067,6 +1096,11 @@ <h2 class="title">S</h2>
10671096
</a>
10681097
<h2 class="title">T</h2>
10691098
<dl>
1099+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.html#toArray--">toArray()</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations">Permutation</a></dt>
1100+
<dd>
1101+
<div class="block">Generates an array of int values from the interval [0, n) in the same order
1102+
that they occur in this Permutation.</div>
1103+
</dd>
10701104
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.html#toBigInteger--">toBigInteger()</a></span> - Method in class org.cicirello.permutations.<a href="org/cicirello/permutations/Permutation.html" title="class in org.cicirello.permutations">Permutation</a></dt>
10711105
<dd>
10721106
<div class="block">Generates a unique integer representing the permutation.</div>

‎docs/api/index.html

+1-1
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 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

+2-2
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 Fri May 10 15:30:00 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:28 EDT 2019 -->
66
<title>JacobiDiagonalization (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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

+2-2
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 Fri May 10 15:30:00 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:28 EDT 2019 -->
66
<title>MatrixOps (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54: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-10">
7+
<meta name="date" content="2019-05-13">
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-summary.html

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54: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-10">
7+
<meta name="date" content="2019-05-13">
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-tree.html

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>org.cicirello.math.la Class Hierarchy (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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/stats/Statistics.html

+2-2
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 Fri May 10 15:30:00 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:28 EDT 2019 -->
66
<title>Statistics (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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/stats/package-frame.html

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>org.cicirello.math.stats (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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/stats/package-summary.html

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>org.cicirello.math.stats (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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/stats/package-tree.html

+2-2
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 Fri May 10 15:30:02 EDT 2019 -->
5+
<!-- Generated by javadoc (1.8.0_05) on Mon May 13 14:54:30 EDT 2019 -->
66
<title>org.cicirello.math.stats Class Hierarchy (JavaPermutationTools - A Java API for computation on permutations)</title>
7-
<meta name="date" content="2019-05-10">
7+
<meta name="date" content="2019-05-13">
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)