Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename some arb-backed types #1824

Merged
merged 6 commits into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/src/matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ $\mathbb{Z}/n\mathbb{Z}$ (large $n$) | Flint | `ZZModMatrix`
$\mathbb{Q}$ | Flint | `QQMatrix` | `QQMatrixSpace`
$\mathbb{Z}/p\mathbb{Z}$ (small $p$) | Flint | `fpMatrix` | `fpMatrixSpace`
$\mathbb{F}_{p^n}$ (small $p$) | Flint | `fqPolyRepMatrix` | `fqPolyRepMatrixSpace`
$\mathbb{F}_{p^n}$ (large $p$) | Flint | `FqPolyRepMatrix` | `FqPolyRepMatrixSpace
$\mathbb{R}$ (arbitrary precision) | Arb | `RealMat` | `RealMatSpace`
$\mathbb{C}$ (arbitrary precision) | Arb | `ComplexMat` | `ComplexMatSpace`
$\mathbb{R}$ (fixed precision) | Arb | `ArbMatrix` | `ArbMatSpace`
$\mathbb{C}$ (fixed precision) | Arb | `AcbMatrix` | `AcbMatSpace`
$\mathbb{F}_{p^n}$ (large $p$) | Flint | `FqPolyRepMatrix` | `FqPolyRepMatrixSpace`
$\mathbb{R}$ (arbitrary precision) | Arb | `RealMatrix` | `RealMatrixSpace`
$\mathbb{C}$ (arbitrary precision) | Arb | `ComplexMatrix` | `ComplexMatrixSpace`
$\mathbb{R}$ (fixed precision) | Arb | `ArbMatrix` | `ArbMatrixSpace`
$\mathbb{C}$ (fixed precision) | Arb | `AcbMatrix` | `AcbMatrixSpace`

The dimensions and base ring $R$ of a generic matrix are stored in its parent
object.
Expand Down Expand Up @@ -59,19 +59,19 @@ matrix functionality, for specific rings in Nemo.
### Comparison operators

```@docs
overlaps(::RealMat, ::RealMat)
overlaps(::RealMatrix, ::RealMatrix)
```

```@docs
overlaps(::ComplexMat, ::ComplexMat)
overlaps(::ComplexMatrix, ::ComplexMatrix)
```

```@docs
contains(::RealMat, ::RealMat)
contains(::RealMatrix, ::RealMatrix)
```

```@docs
contains(::ComplexMat, ::ComplexMat)
contains(::ComplexMatrix, ::ComplexMatrix)
```

In addition we have the following ad hoc comparison operators.
Expand Down Expand Up @@ -488,11 +488,11 @@ julia> B = exp(A)
### Norm

```@docs
bound_inf_norm(::RealMat)
bound_inf_norm(::RealMatrix)
```

```@docs
bound_inf_norm(::ComplexMat)
bound_inf_norm(::ComplexMatrix)
```

**Examples**
Expand Down Expand Up @@ -559,9 +559,9 @@ In case the matrix cannot be converted without loss, an `InexactError` is thrown
### Eigenvalues and Eigenvectors (experimental)

```@docs
eigenvalues(::ComplexMat)
eigenvalues_with_multiplicities(::ComplexMat)
eigenvalues_simple(a::ComplexMat)
eigenvalues(::ComplexMatrix)
eigenvalues_with_multiplicities(::ComplexMatrix)
eigenvalues_simple(a::ComplexMatrix)
```

```jldoctest; setup = :(CC = ComplexField())
Expand Down
34 changes: 17 additions & 17 deletions docs/src/polynomial.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ $\mathbb{Z}/p\mathbb{Z}$ (small prime $p$) | Flint | `fpPolyRingE
$\mathbb{Z}/p\mathbb{Z}$ (large prime $p$) | Flint | `FpPolyRingElem` | `FpPolyRing`
$\mathbb{F}_{p^n}$ (small $p$) | Flint | `fqPolyRepPolyRingElem` | `fqPolyRepPolyRing`
$\mathbb{F}_{p^n}$ (large $p$) | Flint | `FqPolyRepPolyRingElem` | `FqPolyRepPolyRing`
$\mathbb{R}$ (arbitrary precision) | Arb | `RealPoly` | `RealPolyRing`
$\mathbb{C}$ (arbitrary precision) | Arb | `ComplexPoly` | `ComplexPolyRing`
$\mathbb{R}$ (arbitrary precision) | Arb | `RealPolyRingElem` | `RealPolyRing`
$\mathbb{C}$ (arbitrary precision) | Arb | `ComplexPolyRingElem` | `ComplexPolyRing`
$\mathbb{R}$ (fixed precision) | Arb | `ArbPolyRingElem` | `ArbPolyRing`
$\mathbb{C}$ (fixed precision) | Arb | `AcbPolyRingElem` | `AcbPolyRing`

Expand All @@ -57,11 +57,11 @@ AbstractAlgebra.jl, for specific coefficient rings.
### Remove and valuation

```@docs
evaluate2(::RealPoly, ::RealFieldElem)
evaluate2(::RealPolyRingElem, ::RealFieldElem)
```

```@docs
evaluate2(::ComplexPoly, ::ComplexFieldElem)
evaluate2(::ComplexPolyRingElem, ::ComplexFieldElem)
```

**Examples**
Expand Down Expand Up @@ -90,7 +90,7 @@ signature(::QQPolyRingElem)
### Root finding

```@docs
roots(::ComplexPoly)
roots(::ComplexPolyRingElem)
```

**Examples**
Expand Down Expand Up @@ -160,8 +160,8 @@ true
### Bounding absolute values of roots

```@docs
roots_upper_bound(::RealPoly)
roots_upper_bound(::ComplexPoly)
roots_upper_bound(::RealPolyRingElem)
roots_upper_bound(::ComplexPolyRingElem)
```

### Lifting
Expand Down Expand Up @@ -202,28 +202,28 @@ or contain other exact or inexact polynomials. The following functions are
provided for this purpose.

```@docs
overlaps(::RealPoly, ::RealPoly)
overlaps(::ComplexPoly, ::ComplexPoly)
overlaps(::RealPolyRingElem, ::RealPolyRingElem)
overlaps(::ComplexPolyRingElem, ::ComplexPolyRingElem)
```

```@docs
contains(::RealPoly, ::RealPoly)
contains(::ComplexPoly, ::ComplexPoly)
contains(::RealPolyRingElem, ::RealPolyRingElem)
contains(::ComplexPolyRingElem, ::ComplexPolyRingElem)
```

```@docs
contains(::RealPoly, ::ZZPolyRingElem)
contains(::RealPoly, ::QQPolyRingElem)
contains(::ComplexPoly, ::ZZPolyRingElem)
contains(::ComplexPoly, ::QQPolyRingElem)
contains(::RealPolyRingElem, ::ZZPolyRingElem)
contains(::RealPolyRingElem, ::QQPolyRingElem)
contains(::ComplexPolyRingElem, ::ZZPolyRingElem)
contains(::ComplexPolyRingElem, ::QQPolyRingElem)
```

It is sometimes also useful to be able to determine if there is a unique
integer contained in the coefficient of an inexact constant polynomial.

```@docs
unique_integer(::RealPoly)
unique_integer(::ComplexPoly)
unique_integer(::RealPolyRingElem)
unique_integer(::ComplexPolyRingElem)
```

**Examples**
Expand Down
4 changes: 2 additions & 2 deletions docs/src/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ parent objects of the given rings and structures.
- `AcbFieldElem` (`AcbField`)
- `ArbPolyRingElem` (`ArbPolyRing`)
- `AcbPolyRingElem` (`AcbPolyRing`)
- `ArbMatrix` (`ArbMatSpace`)
- `AcbMatrix` (`AcbMatSpace`)
- `ArbMatrix` (`ArbMatrixSpace`)
- `AcbMatrix` (`AcbMatrixSpace`)

- Calcium

Expand Down
9 changes: 8 additions & 1 deletion src/Deprecations.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
# ALL aliases here are only a temporary measure to allow for a smooth transition downstream.
# they will be replaced by deprecations eventually

#= currently none =#
@alias ComplexPoly ComplexPolyRingElem
@alias RealPoly RealPolyRingElem
@alias ComplexMat ComplexMatrix
@alias RealMat RealMatrix
@alias AcbMatSpace AcbMatrixSpace
@alias ComplexMatSpace ComplexMatrixSpace
@alias ArbMatSpace ArbMatrixSpace
@alias RealMatSpace RealMatrixSpace

###############################################################################
#
Expand Down
16 changes: 8 additions & 8 deletions src/Exports.jl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export AbsSimpleNumFieldElem
export AcbField
export AcbFieldElem
export AcbMatrix
export AcbMatSpace
export AcbMatrixSpace
export AcbPolyRing
export AcbPolyRingElem
export accuracy_bits
Expand All @@ -34,7 +34,7 @@ export angle
export ArbField
export ArbFieldElem
export ArbMatrix
export ArbMatSpace
export ArbMatrixSpace
export ArbPolyRing
export ArbPolyRingElem
export Array
Expand Down Expand Up @@ -87,10 +87,10 @@ export compare_index
export complex_normal_form
export ComplexField
export ComplexFieldElem
export ComplexMat
export ComplexMatSpace
export ComplexPoly
export ComplexMatrix
export ComplexMatrixSpace
export ComplexPolyRing
export ComplexPolyRingElem
export compose
export conj
export conjugates
Expand Down Expand Up @@ -525,10 +525,10 @@ export rational_field
export real
export RealField
export RealFieldElem
export RealMat
export RealMatSpace
export RealPoly
export RealMatrix
export RealMatrixSpace
export RealPolyRing
export RealPolyRingElem
export reconstruct
export reduce_mod
export reduce_mod!
Expand Down
Loading
Loading