diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 286614a5..6468706e 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-17T03:16:27","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-18T03:17:59","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/dev/basics/index.html b/dev/basics/index.html index d92115cc..c09a3930 100644 --- a/dev/basics/index.html +++ b/dev/basics/index.html @@ -94,4 +94,4 @@ GAP: [ [ 1, 2 ], [ 3, 4 ] ] julia> GAP.Obj(42) -42source
GAP.GapInt — Type
GapInt

Any GAP integer object is represented in Julia as either a GapObj (if it is a "large" integer) or as an Int (if it is a "small" integer). This type union can be used to express this conveniently, e.g. when one wants to help type stability.

Note that also GAP's infinity and -infinity fit under this type (as do many other objects which are not numbers).

source
+42source
GAP.GapInt — Type
GapInt

Any GAP integer object is represented in Julia as either a GapObj (if it is a "large" integer) or as an Int (if it is a "small" integer). This type union can be used to express this conveniently, e.g. when one wants to help type stability.

Note that also GAP's infinity and -infinity fit under this type (as do many other objects which are not numbers).

source
diff --git a/dev/conversion/index.html b/dev/conversion/index.html index ee9251d4..c420c0f0 100644 --- a/dev/conversion/index.html +++ b/dev/conversion/index.html @@ -247,4 +247,4 @@ julia> Dict{Symbol,Vector{Int}}(val; recursive=true) Dict{Symbol, Vector{Int64}} with 1 entry: :l => [1, 2] -source +source diff --git a/dev/examples/index.html b/dev/examples/index.html index 8c52753c..81e62bea 100644 --- a/dev/examples/index.html +++ b/dev/examples/index.html @@ -145,4 +145,4 @@ julia> length(pre3) 116

... and we verify that the decomposition is correct:

julia> GAP.Globals.Image(fhom, pre3) == r
-true

This concludes our example.

+true

This concludes our example.

diff --git a/dev/index.html b/dev/index.html index ecc16644..1326b068 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -GAP.jl · GAP.jl
GitHub

GAP.jl

Introduction

GAP.jl is a low level interface from Julia to the computer algebra system GAP. The term "low level" means that the aim is to give Julia access to all GAP objects, to let Julia call GAP functions, and to provide conversions of low level data (integers, Booleans, strings, arrays/lists, dictionaries/records) between the two systems.

In particular, it is not the aim of GAP.jl to provide Julia types for higher level GAP objects that represent algebraic structures, such as groups, rings, fields, etc., and mappings between such structures.

The connection between GAP and Julia is in fact bidirectional, that is, GAP can access all Julia objects, call Julia functions, and perform conversions of low level data. This direction will become interesting on the Julia side as soon as GAP packages provide functionality that is based on using Julia code from the GAP side.

The viewpoint of an interface from GAP to Julia is described in the manual of the GAP package JuliaInterface.

Table of contents

+GAP.jl · GAP.jl
GitHub

GAP.jl

Introduction

GAP.jl is a low level interface from Julia to the computer algebra system GAP. The term "low level" means that the aim is to give Julia access to all GAP objects, to let Julia call GAP functions, and to provide conversions of low level data (integers, Booleans, strings, arrays/lists, dictionaries/records) between the two systems.

In particular, it is not the aim of GAP.jl to provide Julia types for higher level GAP objects that represent algebraic structures, such as groups, rings, fields, etc., and mappings between such structures.

The connection between GAP and Julia is in fact bidirectional, that is, GAP can access all Julia objects, call Julia functions, and perform conversions of low level data. This direction will become interesting on the Julia side as soon as GAP packages provide functionality that is based on using Julia code from the GAP side.

The viewpoint of an interface from GAP to Julia is described in the manual of the GAP package JuliaInterface.

Table of contents

diff --git a/dev/internal/index.html b/dev/internal/index.html index 66b7fe6f..468b995d 100644 --- a/dev/internal/index.html +++ b/dev/internal/index.html @@ -3,4 +3,4 @@ 2:2:10 julia> GAP.kwarg_wrapper(range, [2], Dict(:length => 5, :step => 2)) -2:2:10source +2:2:10source diff --git a/dev/manualindex/index.html b/dev/manualindex/index.html index 013c4fdc..b7f99214 100644 --- a/dev/manualindex/index.html +++ b/dev/manualindex/index.html @@ -1,2 +1,2 @@ -Index · GAP.jl
GitHub

Index

+Index · GAP.jl
GitHub

Index

diff --git a/dev/other/index.html b/dev/other/index.html index 5d9350bf..e400141c 100644 --- a/dev/other/index.html +++ b/dev/other/index.html @@ -394,4 +394,4 @@ julia> GAP.show_gap_help( "Size", true ) [...] # about 15 entries from GAP manuals -source +source diff --git a/dev/packages/index.html b/dev/packages/index.html index 9a7c2970..ec090954 100644 --- a/dev/packages/index.html +++ b/dev/packages/index.html @@ -10,4 +10,4 @@ debug::Bool = false, pkgdir::AbstractString = GAP.Packages.DEFAULT_PKGDIR[])

Build the GAP package with name name that is installed in the pkgdir directory.

If no package with name name is installed in pkgdir but there is a version of name bundled with the GAP package distro, this version is copied to pkgdir and built.

Return true if the build was successful or the package was already built, and false otherwise.

The function uses the function CompilePackage from GAP's package PackageManager. The info messages shown by this function can be suppressed by passing true as the value of quiet.

source
GAP.Packages.build_recursive — Function
build_recursive(name::String; quiet::Bool = false,
                     debug::Bool = false,
-                    pkgdir::AbstractString = GAP.Packages.DEFAULT_PKGDIR[])

Build the GAP package with name name that is installed in the pkgdir directory, as well as all of its (transitive) dependencies.

This is achieved by calling build for the package name and then all of its NeededOtherPackages, recursively. All keyword arguments are passed on to build.

source
GAP.Packages.test — Function
test(name::String)

Run the tests of GAP package name and return a boolean indicating whether they succeeded (true) or not.

It is intended to be used with the @test macro from the Test package.

The function uses the GAP function TestPackage.

source
GAP.Packages.locate_package — Function
locate_package(name::String)

Return the path where the GAP package with name name is installed if this package is loaded, and "" otherwise.

source
+ pkgdir::AbstractString = GAP.Packages.DEFAULT_PKGDIR[])

Build the GAP package with name name that is installed in the pkgdir directory, as well as all of its (transitive) dependencies.

This is achieved by calling build for the package name and then all of its NeededOtherPackages, recursively. All keyword arguments are passed on to build.

source
GAP.Packages.test — Function
test(name::String)

Run the tests of GAP package name and return a boolean indicating whether they succeeded (true) or not.

It is intended to be used with the @test macro from the Test package.

The function uses the GAP function TestPackage.

source
GAP.Packages.locate_package — Function
locate_package(name::String)

Return the path where the GAP package with name name is installed if this package is loaded, and "" otherwise.

source