Skip to content

Commit 820f174

Browse files
cicirellocicirello
authored
Merge pull request #113 from cicirello/create-pull-request/docs
Automated API website updates.
2 parents 43c6c7a + 9ff576f commit 820f174

File tree

5 files changed

+62
-8
lines changed

5 files changed

+62
-8
lines changed

‎docs/api/index-all.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1781,6 +1781,10 @@ <h2 class="title">S</h2>
17811781
<div class="block">Changes the state of the Permutation according to the contents
17821782
of an array of int values.</div>
17831783
</dd>
1784+
<dt><span class="memberNameLink"><a href="org/cicirello/permutations/Permutation.Mechanic.html#set(org.cicirello.permutations.Permutation,int%5B%5D,int,int,int)">set(Permutation, int[], int, 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>
1785+
<dd>
1786+
<div class="block">Changes a range of permutation elements.</div>
1787+
</dd>
17841788
<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>
17851789
<dd>
17861790
<div class="block">Changes the integer in one specific location of a Permutation.</div>

‎docs/api/member-search-index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/org/cicirello/permutations/Permutation.Mechanic.html‎

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
catch(err) {
3131
}
3232
//-->
33-
var data = {"i0":10,"i1":10,"i2":10};
33+
var data = {"i0":10,"i1":10,"i2":10,"i3":10};
3434
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
3535
var altColor = "altColor";
3636
var rowColor = "rowColor";
@@ -226,14 +226,25 @@ <h3>Method Summary</h3>
226226
</tr>
227227
<tr id="i1" class="rowColor">
228228
<td class="colFirst"><code>protected void</code></td>
229+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(org.cicirello.permutations.Permutation,int%5B%5D,int,int,int)">set</a></span>&#8203;(<a href="Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
230+
int[]&nbsp;source,
231+
int&nbsp;fromIndex,
232+
int&nbsp;toIndex,
233+
int&nbsp;numElementsToSet)</code></th>
234+
<td class="colLast">
235+
<div class="block">Changes a range of permutation elements.</div>
236+
</td>
237+
</tr>
238+
<tr id="i2" class="altColor">
239+
<td class="colFirst"><code>protected void</code></td>
229240
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(org.cicirello.permutations.Permutation,int,int)">set</a></span>&#8203;(<a href="Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
230241
int&nbsp;index,
231242
int&nbsp;value)</code></th>
232243
<td class="colLast">
233244
<div class="block">Changes the integer in one specific location of a Permutation.</div>
234245
</td>
235246
</tr>
236-
<tr id="i2" class="altColor">
247+
<tr id="i3" class="rowColor">
237248
<td class="colFirst"><code>protected void</code></td>
238249
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(org.cicirello.permutations.Permutation,int,int%5B%5D)">set</a></span>&#8203;(<a href="Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
239250
int&nbsp;index,
@@ -333,7 +344,7 @@ <h4>set</h4>
333344
<a id="set(org.cicirello.permutations.Permutation,int,int[])">
334345
<!-- -->
335346
</a>
336-
<ul class="blockListLast">
347+
<ul class="blockList">
337348
<li class="blockList">
338349
<h4>set</h4>
339350
<pre class="methodSignature">protected final&nbsp;void&nbsp;set&#8203;(<a href="Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
@@ -354,6 +365,34 @@ <h4>set</h4>
354365
</dl>
355366
</li>
356367
</ul>
368+
<a id="set(org.cicirello.permutations.Permutation,int[],int,int,int)">
369+
<!-- -->
370+
</a>
371+
<ul class="blockListLast">
372+
<li class="blockList">
373+
<h4>set</h4>
374+
<pre class="methodSignature">protected final&nbsp;void&nbsp;set&#8203;(<a href="Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
375+
int[]&nbsp;source,
376+
int&nbsp;fromIndex,
377+
int&nbsp;toIndex,
378+
int&nbsp;numElementsToSet)</pre>
379+
<div class="block">Changes a range of permutation elements. This method does not verify that the
380+
change produces a valid permutation. The caller is responsible for making a combination
381+
of calls to this method and/or the other methods of the Permutation.Mechanic class that
382+
together produce a valid Permutation.
383+
The behavior of the Permutation object may become unstable otherwise.
384+
The caller should not return until the state of the Permutation object is again valid.</div>
385+
<dl>
386+
<dt><span class="paramLabel">Parameters:</span></dt>
387+
<dd><code>p</code> - Permutation object to change.</dd>
388+
<dd><code>source</code> - An array to copy elements from.</dd>
389+
<dd><code>fromIndex</code> - An index into source where copying begins, e.g., the first element
390+
copied is source[fromIndex].</dd>
391+
<dd><code>toIndex</code> - An index into the Permutation p, where the elements will be copied to.</dd>
392+
<dd><code>numElementsToSet</code> - The number of elements to copy from source to p.</dd>
393+
</dl>
394+
</li>
395+
</ul>
357396
</li>
358397
</ul>
359398
</section>

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,14 +194,25 @@ <h3>Uses of <a href="../Permutation.html" title="class in org.cicirello.permutat
194194
</tr>
195195
<tr class="rowColor">
196196
<td class="colFirst"><code>protected void</code></td>
197+
<th class="colSecond" scope="row"><span class="typeNameLabel">Permutation.Mechanic.</span><code><span class="memberNameLink"><a href="../Permutation.Mechanic.html#set(org.cicirello.permutations.Permutation,int%5B%5D,int,int,int)">set</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
198+
int[]&nbsp;source,
199+
int&nbsp;fromIndex,
200+
int&nbsp;toIndex,
201+
int&nbsp;numElementsToSet)</code></th>
202+
<td class="colLast">
203+
<div class="block">Changes a range of permutation elements.</div>
204+
</td>
205+
</tr>
206+
<tr class="altColor">
207+
<td class="colFirst"><code>protected void</code></td>
197208
<th class="colSecond" scope="row"><span class="typeNameLabel">Permutation.Mechanic.</span><code><span class="memberNameLink"><a href="../Permutation.Mechanic.html#set(org.cicirello.permutations.Permutation,int,int)">set</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
198209
int&nbsp;index,
199210
int&nbsp;value)</code></th>
200211
<td class="colLast">
201212
<div class="block">Changes the integer in one specific location of a Permutation.</div>
202213
</td>
203214
</tr>
204-
<tr class="altColor">
215+
<tr class="rowColor">
205216
<td class="colFirst"><code>protected void</code></td>
206217
<th class="colSecond" scope="row"><span class="typeNameLabel">Permutation.Mechanic.</span><code><span class="memberNameLink"><a href="../Permutation.Mechanic.html#set(org.cicirello.permutations.Permutation,int,int%5B%5D)">set</a></span>&#8203;(<a href="../Permutation.html" title="class in org.cicirello.permutations">Permutation</a>&nbsp;p,
207218
int&nbsp;index,

‎docs/sitemap.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
</url>
3535
<url>
3636
<loc>https://jpt.cicirello.org/api/index-all.html</loc>
37-
<lastmod>2021-03-29T21:19:43+00:00</lastmod>
37+
<lastmod>2021-03-31T16:34:31+00:00</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://jpt.cicirello.org/api/overview-summary.html</loc>
@@ -66,7 +66,7 @@
6666
</url>
6767
<url>
6868
<loc>https://jpt.cicirello.org/api/org/cicirello/permutations/Permutation.Mechanic.html</loc>
69-
<lastmod>2021-01-28T16:35:50+00:00</lastmod>
69+
<lastmod>2021-03-31T16:34:31+00:00</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://jpt.cicirello.org/api/org/cicirello/permutations/Permutation.html</loc>
@@ -186,7 +186,7 @@
186186
</url>
187187
<url>
188188
<loc>https://jpt.cicirello.org/api/org/cicirello/permutations/class-use/Permutation.html</loc>
189-
<lastmod>2021-03-29T21:19:43+00:00</lastmod>
189+
<lastmod>2021-03-31T16:34:31+00:00</lastmod>
190190
</url>
191191
<url>
192192
<loc>https://jpt.cicirello.org/api/org/cicirello/permutations/class-use/PermutationIterator.html</loc>

0 commit comments

Comments
 (0)