Skip to content

Commit

Permalink
build based on a23d189
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 13, 2024
1 parent 06c9afe commit 20fc987
Show file tree
Hide file tree
Showing 13 changed files with 82 additions and 82 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-06T15:55:11","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-13T21:46:35","documenter_version":"1.4.1"}}
16 changes: 8 additions & 8 deletions dev/assets/html/JuliaInterface/chap2.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions dev/assets/html/JuliaInterface/chap2_mj.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions dev/assets/html/JuliaInterface/chap3.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h5>3.1-1 <span class="Heading">Guiding principles</span></h5>

<h5>3.1-2 <span class="Heading">Automatic (implicit) conversions</span></h5>

<p><strong class="pkg">GAP</strong> has a notion of <q>immediate</q> objects, whose values are stored inside the <q>pointer</q> referencing them. <strong class="pkg">GAP</strong> uses this to store small integers and elements of small finite fields, see for example the beginning of Chapter <a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap14.html#X853DF11B80068ED5"><span class="RefLink">Reference: Integers</span></a> in the <strong class="pkg">GAP</strong> Reference Manual. Since these are not valid pointers, <strong class="pkg">Julia</strong> cannot treat them like other <strong class="pkg">GAP</strong> objects, which are simply <strong class="pkg">Julia</strong> objects of type <code class="code">GAP.GapObj</code>. Instead, a conversion is unavoidable, at least when immediate objects are passed as stand-alone arguments to a function.</p>
<p><strong class="pkg">GAP</strong> has a notion of <q>immediate</q> objects, whose values are stored inside the <q>pointer</q> referencing them. <strong class="pkg">GAP</strong> uses this to store small integers and elements of small finite fields, see for example the beginning of Chapter <a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap14.html#X853DF11B80068ED5"><span class="RefLink">Reference: Integers</span></a> in the <strong class="pkg">GAP</strong> Reference Manual. Since these are not valid pointers, <strong class="pkg">Julia</strong> cannot treat them like other <strong class="pkg">GAP</strong> objects, which are simply <strong class="pkg">Julia</strong> objects of type <code class="code">GAP.GapObj</code>. Instead, a conversion is unavoidable, at least when immediate objects are passed as stand-alone arguments to a function.</p>

<p>To this end, the interface converts <strong class="pkg">GAP</strong> immediate integers into <strong class="pkg">Julia</strong> <code class="code">Int64</code> objects, and vice versa. However, <strong class="pkg">GAP</strong> immediate integers on a 64 bit system can only store 61 bits, so not all <code class="code">Int64</code>objects can be converted into immediate integers; integers exceeding the 61 bits limit are therefore wrapped like any other <strong class="pkg">Julia</strong> object. Other <strong class="pkg">Julia</strong> integer types, like <code class="code">UInt64</code>, <code class="code">Int32</code>, are also wrapped by default, in order to ensure that conversion round trips do not arbitrary change object types.</p>

Expand Down Expand Up @@ -334,7 +334,7 @@ <h5>3.2-2 JuliaToGAP</h5>
[ [ 1, 2 ], [ 3, 4 ] ]
</pre></div>

<p>The following values for <var class="Arg">filt</var> are supported. <code class="func">IsInt</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap14.html#X87AEADF07DC8303B"><span class="RefLink">Reference: IsInt</span></a>), <code class="func">IsRat</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap17.html#X7ED018F5794935F7"><span class="RefLink">Reference: IsRat</span></a>), <code class="func">IsFFE</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap59.html#X7D3DF32C84FEBD25"><span class="RefLink">Reference: IsFFE</span></a>), <code class="code">IsFloat</code> (see <a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap19.html#X81AA901181CA568F"><span class="RefLink">Reference: Floats</span></a>), <code class="func">IsBool</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap20.html#X7D58580284CF7894"><span class="RefLink">Reference: IsBool</span></a>), <code class="func">IsChar</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap27.html#X80CFAE128560E064"><span class="RefLink">Reference: IsChar</span></a>), <code class="func">IsRecord</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap29.html#X782A998E7D9EC406"><span class="RefLink">Reference: IsRecord</span></a>), <code class="func">IsString</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap27.html#X78723B5D795A3B6D"><span class="RefLink">Reference: IsString</span></a>), <code class="func">IsRange</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap21.html#X86DDC2FF7A50FBEE"><span class="RefLink">Reference: IsRange</span></a>), <code class="func">IsBlist</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap22.html#X7BE078187A08DCEA"><span class="RefLink">Reference: IsBlist</span></a>), <code class="func">IsList</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap21.html#X7C4CC4EA8299701E"><span class="RefLink">Reference: IsList</span></a>). See Section <a href="chap3.html#X85C0815A7DD15788"><span class="RefLink">3.1</span></a> for the admissible types of <var class="Arg">juliaobj</var> in these cases.</p>
<p>The following values for <var class="Arg">filt</var> are supported. <code class="func">IsInt</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap14.html#X87AEADF07DC8303B"><span class="RefLink">Reference: IsInt</span></a>), <code class="func">IsRat</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap17.html#X7ED018F5794935F7"><span class="RefLink">Reference: IsRat</span></a>), <code class="func">IsFFE</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap59.html#X7D3DF32C84FEBD25"><span class="RefLink">Reference: IsFFE</span></a>), <code class="code">IsFloat</code> (see <a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap19.html#X81AA901181CA568F"><span class="RefLink">Reference: Floats</span></a>), <code class="func">IsBool</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap20.html#X7D58580284CF7894"><span class="RefLink">Reference: IsBool</span></a>), <code class="func">IsChar</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap27.html#X80CFAE128560E064"><span class="RefLink">Reference: IsChar</span></a>), <code class="func">IsRecord</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap29.html#X782A998E7D9EC406"><span class="RefLink">Reference: IsRecord</span></a>), <code class="func">IsString</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap27.html#X78723B5D795A3B6D"><span class="RefLink">Reference: IsString</span></a>), <code class="func">IsRange</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap21.html#X86DDC2FF7A50FBEE"><span class="RefLink">Reference: IsRange</span></a>), <code class="func">IsBlist</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap22.html#X7BE078187A08DCEA"><span class="RefLink">Reference: IsBlist</span></a>), <code class="func">IsList</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap21.html#X7C4CC4EA8299701E"><span class="RefLink">Reference: IsList</span></a>). See Section <a href="chap3.html#X85C0815A7DD15788"><span class="RefLink">3.1</span></a> for the admissible types of <var class="Arg">juliaobj</var> in these cases.</p>

<p><a id="X860C2F3184F70021" name="X860C2F3184F70021"></a></p>

Expand Down Expand Up @@ -395,13 +395,13 @@ <h5>3.3-1 IsRandomSourceJulia</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#8227; IsRandomSourceJulia</code>( <var class="Arg">obj</var> )</td><td class="tdright">(&nbsp;filter&nbsp;)</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code></p>

<p>This filter allows one to use <strong class="pkg">Julia</strong>'s random number generators in <strong class="pkg">GAP</strong>, see <a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap14.html#X85361FAE8088C006"><span class="RefLink">Reference: Random Sources</span></a> for the background. Calling <code class="func">RandomSource</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap14.html#X7CB0B5BC82F8FD8F"><span class="RefLink">Reference: RandomSource</span></a>) with only argument <code class="func">IsRandomSourceJulia</code> yields a <strong class="pkg">GAP</strong> random source that uses a copy of <strong class="pkg">Julia</strong>'s default random number generator <code class="code">Julia.Random.default_rng()</code>. Note that different calls with only argument <code class="func">IsRandomSourceJulia</code> yield different random sources.</p>
<p>This filter allows one to use <strong class="pkg">Julia</strong>'s random number generators in <strong class="pkg">GAP</strong>, see <a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap14.html#X85361FAE8088C006"><span class="RefLink">Reference: Random Sources</span></a> for the background. Calling <code class="func">RandomSource</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap14.html#X7CB0B5BC82F8FD8F"><span class="RefLink">Reference: RandomSource</span></a>) with only argument <code class="func">IsRandomSourceJulia</code> yields a <strong class="pkg">GAP</strong> random source that uses a copy of <strong class="pkg">Julia</strong>'s default random number generator <code class="code">Julia.Random.default_rng()</code>. Note that different calls with only argument <code class="func">IsRandomSourceJulia</code> yield different random sources.</p>

<p>Called with <code class="func">IsRandomSourceJulia</code> and a positive integer, <code class="func">RandomSource</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap14.html#X7CB0B5BC82F8FD8F"><span class="RefLink">Reference: RandomSource</span></a>) returns a random source that is based on a copy of <code class="code">Julia.Random.default_rng()</code> but got initialized with the given integer as a seed.</p>
<p>Called with <code class="func">IsRandomSourceJulia</code> and a positive integer, <code class="func">RandomSource</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap14.html#X7CB0B5BC82F8FD8F"><span class="RefLink">Reference: RandomSource</span></a>) returns a random source that is based on a copy of <code class="code">Julia.Random.default_rng()</code> but got initialized with the given integer as a seed.</p>

<p>Called with <code class="func">IsRandomSourceJulia</code> and a <strong class="pkg">Julia</strong> random number generator, <code class="func">RandomSource</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap14.html#X7CB0B5BC82F8FD8F"><span class="RefLink">Reference: RandomSource</span></a>) returns a random source that uses this random number generator. Note that we do <em>not</em> make a copy of the second argument, in order to be able to use the given random number generator both on the <strong class="pkg">GAP</strong> side and the <strong class="pkg">Julia</strong> side.</p>
<p>Called with <code class="func">IsRandomSourceJulia</code> and a <strong class="pkg">Julia</strong> random number generator, <code class="func">RandomSource</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap14.html#X7CB0B5BC82F8FD8F"><span class="RefLink">Reference: RandomSource</span></a>) returns a random source that uses this random number generator. Note that we do <em>not</em> make a copy of the second argument, in order to be able to use the given random number generator both on the <strong class="pkg">GAP</strong> side and the <strong class="pkg">Julia</strong> side.</p>

<p><code class="func">State</code> (<a href="/home/runner/.julia/artifacts/5388018bf82d2c84822fccc1b4d413fedcd28881/share/gap/doc/ref/chap14.html#X86FFFBC9790F9742"><span class="RefLink">Reference: State</span></a>) for random sources in <code class="func">IsRandomSourceJulia</code> returns a copy of the underlying <strong class="pkg">Julia</strong> random number generator.</p>
<p><code class="func">State</code> (<a href="/home/runner/.julia/artifacts/7a7471c3a274d605d85c06775fcb6f9962114ff7/share/gap/doc/ref/chap14.html#X86FFFBC9790F9742"><span class="RefLink">Reference: State</span></a>) for random sources in <code class="func">IsRandomSourceJulia</code> returns a copy of the underlying <strong class="pkg">Julia</strong> random number generator.</p>


<div class="example"><pre>
Expand Down
Loading

0 comments on commit 20fc987

Please sign in to comment.