Skip to content

Commit

Permalink
Rename isFOO -> is_FOO (#690)
Browse files Browse the repository at this point in the history
  • Loading branch information
fingolfin committed May 12, 2022
1 parent a066a63 commit 2e50da4
Show file tree
Hide file tree
Showing 279 changed files with 2,808 additions and 2,627 deletions.
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Expand Up @@ -11,9 +11,5 @@

- Use lower case with underscores for method names, for example,
`prime_decomposition` instead of `primedecomposition` and
`basis_matrix` instead of `basismat`. The only exception are method
names that start with an `is` (predicates). In this case there is
no underscore between `is` and the word that follows. For example,
it is `issubgroup` instead of `is_subgroup` and `istorsion_point`
instead of `is_torsion_point`.
`basis_matrix` instead of `basismat`.
- Use upper camel case convention for type names
2 changes: 1 addition & 1 deletion TODO.md
Expand Up @@ -29,7 +29,7 @@
* [ ] Clean up the clever `princ_gen_special` code
* [ ] Implement Arakelov and/or divisor type
* [ ] Finite places
* [ ] Need `ismaximal_order_known` and `isautomorphism_group_known`
* [ ] Need `is_maximal_order_known` and `isautomorphism_group_known`
* [x] `relative_extension`
* [ ] `is_locally_power` (at given primes or up to given bound)
* [x] Frobenius automorphism of a field at a prime ideal
Expand Down
2 changes: 1 addition & 1 deletion docs/src/FacElem.md
Expand Up @@ -97,7 +97,7 @@ signs(::Union{FacElem{nf_elem,AnticNumberField}, nf_elem}, ::Vector{InfPlc})
sign(::Union{FacElem{nf_elem,AnticNumberField}, nf_elem}, ::InfPlc)
is_positive(::Union{FacElem{nf_elem,AnticNumberField}, nf_elem}, ::InfPlc)
is_positive(::Union{FacElem{nf_elem,AnticNumberField}, nf_elem}, ::Vector{InfPlc})
istotally_positive(::Union{FacElem{nf_elem,AnticNumberField}, nf_elem})
is_totally_positive(::Union{FacElem{nf_elem,AnticNumberField}, nf_elem})
```

```@docs
Expand Down
2 changes: 1 addition & 1 deletion docs/src/abelian/elements.md
Expand Up @@ -24,7 +24,7 @@ getindex(x::GrpAbFinGenElem, i::Int)

### Predicates

We have the standard predicated `iszero`, `isone` and `isidentity`
We have the standard predicates `iszero`, `isone` and `is_identity`
to test an element for being trivial.

### Invariants
Expand Down
6 changes: 3 additions & 3 deletions docs/src/abelian/introduction.md
Expand Up @@ -57,13 +57,13 @@ ngens(A::GrpAbFinGen)
nrels(G::GrpAbFinGen)
rels(A::GrpAbFinGen)
isfinite(A::GrpAbFinGen)
isinfinite(A::GrpAbFinGen)
is_infinite(A::GrpAbFinGen)
rank(A::GrpAbFinGen)
order(A::GrpAbFinGen)
exponent(A::GrpAbFinGen)
istrivial(A::GrpAbFinGen)
istorsion(G::GrpAbFinGen)
iscyclic(G::GrpAbFinGen)
is_torsion(G::GrpAbFinGen)
is_cyclic(G::GrpAbFinGen)
elementary_divisors(G::GrpAbFinGen)
```

2 changes: 1 addition & 1 deletion docs/src/abelian/structural.md
Expand Up @@ -66,7 +66,7 @@ For 2 subgroups `U` and `V` of the same group `G`, `U+V` returns
the smallest subgroup of `G` containing both. Similarly, $U\cap V$
computes the intersection and `U \subset V` tests for inclusion.
The difference between `issubset =` $\subset$ and
`issubgroup` is that the inclusion map is also returned in the 2nd call.
`is_subgroup` is that the inclusion map is also returned in the 2nd call.

```@docs
intersect(mG::GrpAbFinGenMap, mH::GrpAbFinGenMap)
Expand Down
18 changes: 9 additions & 9 deletions docs/src/class_fields/intro.md
Expand Up @@ -31,8 +31,8 @@ the narrow class group, or strict class group.
```@docs
ray_class_group(m::Hecke.NfAbsOrdIdl{Nemo.AnticNumberField,Nemo.nf_elem}, inf_plc::Vector{Hecke.InfPlc}; p_part, n_quo)
class_group(K::Nemo.AnticNumberField)
norm_group(f::Nemo.PolyElem, mR::Hecke.MapRayClassGrp, isabelian::Bool)
norm_group(K::NfRel{nf_elem}, mR::Hecke.MapRayClassGrp, isabelian::Bool)
norm_group(f::Nemo.PolyElem, mR::Hecke.MapRayClassGrp, is_abelian::Bool)
norm_group(K::NfRel{nf_elem}, mR::Hecke.MapRayClassGrp, is_abelian::Bool)
```


Expand Down Expand Up @@ -106,10 +106,10 @@ base_field(A::Hecke.ClassField)
discriminant(C::Hecke.ClassField)
conductor(C::Hecke.ClassField)
defining_modulus(C::ClassField)
iscyclic(C::ClassField)
isconductor(C::Hecke.ClassField, m::NfOrdIdl, inf_plc::Vector{InfPlc})
isnormal(C::ClassField)
iscentral(C::ClassField)
is_cyclic(C::ClassField)
is_conductor(C::Hecke.ClassField, m::NfOrdIdl, inf_plc::Vector{InfPlc})
is_normal(C::ClassField)
is_central(C::ClassField)
```

## Operations
Expand All @@ -119,9 +119,9 @@ compositum(a::Hecke.ClassField, b::Hecke.ClassField)
==(a::Hecke.ClassField, b::Hecke.ClassField)
intersect(a::Hecke.ClassField, b::Hecke.ClassField)
prime_decomposition_type(C::Hecke.ClassField, p::Hecke.NfAbsOrdIdl)
Hecke.issubfield(a::ClassField, b::ClassField)
Hecke.islocal_norm(r::Hecke.ClassField, a::Hecke.NfAbsOrdElem)
Hecke.islocal_norm(r::Hecke.ClassField, a::Hecke.NfAbsOrdElem, p::Hecke.NfAbsOrdIdl)
Hecke.is_subfield(a::ClassField, b::ClassField)
Hecke.is_local_norm(r::Hecke.ClassField, a::Hecke.NfAbsOrdElem)
Hecke.is_local_norm(r::Hecke.ClassField, a::Hecke.NfAbsOrdElem, p::Hecke.NfAbsOrdIdl)
Hecke.normal_closure(r::Hecke.ClassField)
subfields(r::ClassField)
subfields(r::ClassField, d::Int)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/misc.md
Expand Up @@ -5,7 +5,7 @@
```@docs
euler_phi_inv
Hecke.modord(::fmpz, ::fmpz)
Hecke.isprime_power(::fmpz)
Hecke.is_prime_power(::fmpz)
Hecke.primes_up_to(::Int)
```

Expand Down
2 changes: 1 addition & 1 deletion docs/src/misc/conjugacy.md
@@ -1,5 +1,5 @@
# Conjugacy of integral matrices

```@docs
isGLZ_conjugate(::fmpz_mat, ::fmpz_mat)
is_GLZ_conjugate(::fmpz_mat, ::fmpz_mat)
```
10 changes: 5 additions & 5 deletions docs/src/number_fields/elements.md
Expand Up @@ -74,11 +74,11 @@ is_negative(::nf_elem, ::InfPlc)
### Predicates

```@docs
isintegral(::NumFieldElem)
istorsion_unit(::nf_elem)
islocal_norm(::NumField, ::NumFieldElem, ::Any)
isnorm_divisible(::nf_elem, ::fmpz)
isnorm(::AnticNumberField, ::fmpz)
is_integral(::NumFieldElem)
is_torsion_unit(::nf_elem)
is_local_norm(::NumField, ::NumFieldElem, ::Any)
is_norm_divisible(::nf_elem, ::fmpz)
is_norm(::AnticNumberField, ::fmpz)
```

### Invariants
Expand Down
34 changes: 17 additions & 17 deletions docs/src/number_fields/fields.md
Expand Up @@ -76,31 +76,31 @@ absolute_discriminant(::SimpleNumField)
## Predicates

```@docs
issimple(::NumField)
isabsolute(::NumField)
istotally_real(::NumField)
istotally_complex(::NumField)
iscm_field(::NumField)
iskummer_extension(::SimpleNumField)
isradical_extension(::SimpleNumField)
islinearly_disjoint(::SimpleNumField, ::SimpleNumField)
isweakly_ramified(::AnticNumberField, ::NfOrdIdl)
istamely_ramified(::AnticNumberField)
istamely_ramified(::AnticNumberField, p::Int)
isabelian(::NumField)
is_simple(::NumField)
is_absolute(::NumField)
is_totally_real(::NumField)
is_totally_complex(::NumField)
is_cm_field(::NumField)
is_kummer_extension(::SimpleNumField)
is_radical_extension(::SimpleNumField)
is_linearly_disjoint(::SimpleNumField, ::SimpleNumField)
is_weakly_ramified(::AnticNumberField, ::NfOrdIdl)
is_tamely_ramified(::AnticNumberField)
is_tamely_ramified(::AnticNumberField, p::Int)
is_abelian(::NumField)
```

### Subfields

```@docs
issubfield(::SimpleNumField, ::SimpleNumField)
is_subfield(::SimpleNumField, ::SimpleNumField)
subfields(::SimpleNumField)
principal_subfields(::SimpleNumField)
compositum(::AnticNumberField, ::AnticNumberField)
embedding(::NumField, ::NumField)
normal_closure(::AnticNumberField)
relative_simple_extension(::NumField, ::NumField)
issubfield_normal(::AnticNumberField, ::AnticNumberField)
is_subfield_normal(::AnticNumberField, ::AnticNumberField)
```

## Conversion
Expand All @@ -117,7 +117,7 @@ simplified_simple_extension(::NonSimpleNumField)
```@docs
is_isomorphic(::SimpleNumField, ::SimpleNumField)
is_isomorphic_with_map(::SimpleNumField, ::SimpleNumField)
isinvolution(::NfToNfMor)
is_involution(::NfToNfMor)
fixed_field(::NumFieldMor)
automorphisms(::NumField)
automorphism_group(::AnticNumberField)
Expand All @@ -140,7 +140,7 @@ infinite_places(K::NumField)
real_places(K::AnticNumberField)
complex_places(K::AnticNumberField)
isreal(::Plc)
iscomplex(::Plc)
is_complex(::Plc)
infinite_places_uniformizers(::AnticNumberField)
```

Expand All @@ -150,5 +150,5 @@ infinite_places_uniformizers(::AnticNumberField)
norm_equation(::AnticNumberField, ::Any)
lorenz_module(::AnticNumberField, ::Int)
kummer_failure(::nf_elem, ::Int, ::Int)
isdefining_polynomial_nice(::AnticNumberField)
is_defining_polynomial_nice(::AnticNumberField)
```
14 changes: 7 additions & 7 deletions docs/src/orders/ideals.md
Expand Up @@ -94,8 +94,8 @@ In general, due to the size of the objetcs, the ```fac_elem``` versions are
more effcient.

```@docs
Hecke.isprincipal(::NfOrdIdl)
isprincipal_fac_elem(::NfAbsOrdIdl{AnticNumberField,nf_elem})
Hecke.is_principal(::NfOrdIdl)
is_principal_fac_elem(::NfAbsOrdIdl{AnticNumberField,nf_elem})
power_class(::NfOrdIdl,::fmpz)
power_product_class(::Vector{NfOrdIdl}, ::Vector{fmpz})
power_reduce(::NfAbsOrdIdl{AnticNumberField,nf_elem},::fmpz)
Expand All @@ -107,10 +107,10 @@ prime_ideals_up_to

```@repl 2
I = mc(c[1])
Hecke.isprincipal(I)
Hecke.is_principal(I)
I = I^Int(order(c[1]))
Hecke.isprincipal(I)
Hecke.isprincipal_fac_elem(I)
Hecke.is_principal(I)
Hecke.is_principal_fac_elem(I)
```

The computation of $S$-units is also tied to the class group:
Expand Down Expand Up @@ -169,8 +169,8 @@ norm(::NfOrdIdl)
Hecke.has_norm(::NfOrdIdl)
idempotents(::NfOrdIdl, ::NfOrdIdl)
is_prime(::NfOrdIdl)
Hecke.isprime_known(::NfOrdIdl)
isramified(::NfOrd, ::Union{Int, fmpz})
Hecke.is_prime_known(::NfOrdIdl)
is_ramified(::NfOrd, ::Union{Int, fmpz})
ramification_index(::NfOrdIdl)
degree(::NfOrdIdl)
valuation(::nf_elem, ::NfOrdIdl)
Expand Down
4 changes: 2 additions & 2 deletions docs/src/orders/introduction.md
Expand Up @@ -70,8 +70,8 @@ Once orders are created, we can play with elements and ideals:
```@repl 1
lp = prime_decomposition(Z_K, 2)
p = lp[1][1]
isprincipal(p)
fl, alpha = isprincipal(p^2)
is_principal(p)
fl, alpha = is_principal(p^2)
norm(alpha)
```

Expand Down
14 changes: 7 additions & 7 deletions docs/src/orders/orders.md
Expand Up @@ -57,7 +57,7 @@ inv_coeff_ideals(::NfRelOrd)
basis_matrix(::NfAbsOrd)
basis_mat_inv(::NfOrd)
gen_index(::NfOrd)
isindex_divisor(::NfOrd, ::fmpz)
is_index_divisor(::NfOrd, ::fmpz)
minkowski_matrix(::NfOrd, ::Int)
in(::nf_elem, ::NfOrd)
norm_change_const(::NfOrd)
Expand All @@ -82,9 +82,9 @@ degree(::NfOrd)
index(::NfOrd)
different(::NfOrd)
codifferent(::NfOrd)
isgorenstein(::NfOrd)
isbass(::NfOrd)
isequation_order(::NfOrd)
is_gorenstein(::NfOrd)
is_bass(::NfOrd)
is_equation_order(::NfOrd)
zeta_log_residue(::NfOrd, ::Float64)
ramified_primes(::NfOrd)
```
Expand Down Expand Up @@ -118,13 +118,13 @@ For the processing of units, there are a couple of helper functions
also available:

```@docs
isindependent
is_independent
```

## Predicates

```@docs
Hecke.iscontained(::NfAbsOrd, ::NfAbsOrd)
ismaximal(::NfAbsOrd)
Hecke.is_contained(::NfAbsOrd, ::NfAbsOrd)
is_maximal(::NfAbsOrd)
```

0 comments on commit 2e50da4

Please sign in to comment.