#     This file belongs to ALCO: Tools for Algebraic Combinatorics.
#     Copyright (C) 2024, Benjamin Nasmith

#     This program is free software: you can redistribute it and/or modify
#     it under the terms of the GNU General Public License as published by
#     the Free Software Foundation, either version 3 of the License, or
#     (at your option) any later version.

#     This program is distributed in the hope that it will be useful,
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#     GNU General Public License for more details.

#     You should have received a copy of the GNU General Public License
#     along with this program.  If not, see <https://www.gnu.org/licenses/>.

# Cyclotomic Tools

DeclareOperation( "IsEisenInt", [ IsCyc ] );

DeclareGlobalName( "EisensteinIntegers");

DeclareCategory( "IsEisensteinIntegers", IsEuclideanRing and IsFLMLOR
  and IsFiniteDimensional );

DeclareRepresentation(
    "IsCanonicalBasisEisensteinIntegersRep", IsAttributeStoringRep,
    [ "conductor", "zumbroichbase" ] );

DeclareOperation( "Coefficients", [ IsCanonicalBasisEisensteinIntegersRep,
      IsCyc ] );

DeclareOperation("IsKleinInt", [ IsCyc ] );

DeclareGlobalName( "KleinianIntegers");

DeclareCategory( "IsKleinianIntegers", IsEuclideanRing and IsFLMLOR
  and IsFiniteDimensional );

DeclareRepresentation(
    "IsCanonicalBasisKleinianIntegersRep", IsAttributeStoringRep );

DeclareOperation( "Coefficients", [ IsCanonicalBasisKleinianIntegersRep,
      IsCyc ] );

# Quaternion Tools

DeclareOperation("IsHurwitzInt", [ IsQuaternion ] );

DeclareGlobalName( "HurwitzIntegers" );

DeclareCategory( "IsHurwitzIntegers", IsFLMLOR
  and IsFiniteDimensional and IsQuaternionCollection );

DeclareRepresentation(
    "IsCanonicalBasisHurwitzIntegersRep", IsAttributeStoringRep );

DeclareOperation( "Coefficients", [ IsCanonicalBasisHurwitzIntegersRep,
      IsQuaternion ] );

# Icosian and Golden Field Tools

DeclareGlobalFunction( "GoldenRationalComponent" );

DeclareGlobalFunction( "GoldenIrrationalComponent" );

DeclareGlobalFunction( "GoldenModSigma" );

DeclareOperation("IsIcosian", [ IsQuaternion ] );

DeclareGlobalName( "IcosianRing" );

DeclareCategory( "IsIcosianRing", IsFLMLOR
  and IsFiniteDimensional );

DeclareRepresentation(
    "IsCanonicalBasisIcosianRingRep", IsAttributeStoringRep );

DeclareOperation( "Coefficients", [ IsCanonicalBasisIcosianRingRep,
      IsQuaternion ] );

# Octonion Algebra and Arithmetic Tools

DeclareCategory( "IsOctonion", IsScalar );

DeclareCategory( "IsOctonionArithmeticElement", IsOctonion );

DeclareCategoryCollections( "IsOctonion" );

DeclareCategoryCollections( "IsOctonionCollection" );

DeclareAttribute( "Norm", IsOctonionCollection );

BindGlobal( "OctonionAlgebraData", NEW_SORTED_CACHE(true) );

DeclareCategory( "IsOctonionAlgebra", IsOctonionCollection and IsFullSCAlgebra );

    DeclareAttribute( "GramMatrix", IsOctonionAlgebra );

DeclareOperation("IsOctavianInt", [ IsOctonion ] );

DeclareGlobalName( "OctavianIntegers" );

DeclareCategory( "IsOctavianIntegers", IsFLMLOR
  and IsFiniteDimensional );

DeclareRepresentation(
    "IsCanonicalBasisOctavianIntegersRep", IsAttributeStoringRep );

DeclareOperation( "Coefficients", [ IsCanonicalBasisOctavianIntegersRep,
      IsOctonion ] );

DeclareGlobalFunction( "OctonionAlgebra" );

DeclareGlobalFunction( "OctonionToRealVector" );

DeclareGlobalFunction( "RealToOctonionVector" );

DeclareGlobalFunction( "VectorToIdempotentMatrix" );

DeclareGlobalFunction( "WeylReflection" );

# Jordan Algebra Tools

DeclareCategory( "IsJordanAlgebra", IsAlgebra );

    DeclareAttribute( "JordanRank", IsJordanAlgebra );

    DeclareAttribute( "JordanDegree", IsJordanAlgebra );

    DeclareAttribute( "JordanMatrixBasis", IsJordanAlgebra );

    DeclareAttribute( "JordanOffDiagonalBasis", IsJordanAlgebra );

    DeclareAttribute( "JordanHomotopeVector", IsJordanAlgebra );

    DeclareAttribute( "JordanBasisTraces", IsJordanAlgebra );

DeclareCategory( "IsJordanAlgebraObj", IsSCAlgebraObj );

    DeclareGlobalFunction( "GenericMinimalPolynomial" );

    DeclareAttribute( "JordanRank", IsJordanAlgebraObj );

    DeclareAttribute( "JordanDegree", IsJordanAlgebraObj );

    DeclareAttribute( "JordanAdjugate", IsJordanAlgebraObj );

    DeclareAttribute( "IsPositiveDefinite", IsJordanAlgebraObj );

DeclareGlobalFunction( "HermitianJordanAlgebraBasis" );

DeclareGlobalFunction( "HermitianMatrixToJordanCoefficients" );

DeclareGlobalFunction( "HermitianMatrixToJordanVector" );

DeclareGlobalFunction( "JordanSpinFactor" );

DeclareGlobalFunction( "HermitianSimpleJordanAlgebra" );

DeclareAttribute( "JordanAlgebraGramMatrix", IsJordanAlgebra );

DeclareGlobalFunction( "JordanHomotope" );

DeclareGlobalFunction( "SimpleEuclideanJordanAlgebra" );

# Albert Algebra Tools

BindGlobal( "AlbertAlgebraData", NEW_SORTED_CACHE(true) );

DeclareGlobalFunction( "AlbertAlgebra" );

DeclareCategory( "IsAlbertAlgebraObj", IsJordanAlgebraObj );

DeclareGlobalFunction( "HermitianMatrixToAlbertVector" );

DeclareGlobalFunction( "AlbertVectorToHermitianMatrix" );

DeclareOperation("JordanQuadraticOperator", [IsJordanAlgebraObj, IsJordanAlgebraObj]);

DeclareOperation("JordanQuadraticOperator", [IsJordanAlgebraObj]);

DeclareOperation("JordanTripleSystem", [IsJordanAlgebraObj, IsJordanAlgebraObj, IsJordanAlgebraObj]);

# T-Design Tools

DeclareGlobalFunction( "JacobiPolynomial" );

DeclareGlobalFunction( "Q_k_epsilon" );

DeclareGlobalFunction( "R_k_epsilon" );

# Designs

DeclareCategory( "IsJordanDesign", IsObject );

DeclareCategory( "IsSphericalJordanDesign", IsJordanDesign );

DeclareCategory( "IsProjectiveJordanDesign", IsJordanDesign );

DeclareGlobalFunction( "JordanDesignByParameters" );

DeclareAttribute( "JordanDesignRank", IsJordanDesign );

DeclareAttribute( "JordanDesignDegree", IsJordanDesign );

DeclareAttribute( "JordanDesignQPolynomials", IsJordanDesign );

DeclareAttribute( "JordanDesignConnectionCoefficients", IsJordanDesign );

DeclareCategory( "IsJordanDesignWithAngleSet", IsJordanDesign );

DeclareAttribute( "JordanDesignAngleSet", IsJordanDesignWithAngleSet );

DeclareOperation( "JordanDesignAddAngleSet", [ IsJordanDesign, IsList ] );

DeclareGlobalFunction( "JordanDesignByAngleSet" );

DeclareAttribute( "JordanDesignNormalizedAnnihilatorPolynomial", IsJordanDesignWithAngleSet );

DeclareAttribute( "JordanDesignNormalizedIndicatorCoefficients", IsJordanDesignWithAngleSet );

DeclareCategory( "IsJordanDesignWithPositiveIndicatorCoefficients", IsJordanDesignWithAngleSet );

DeclareAttribute( "JordanDesignSpecialBound", IsJordanDesignWithAngleSet ); 

DeclareCategory( "IsJordanDesignWithCardinality", IsJordanDesign );

DeclareCategory( "IsRegularSchemeJordanDesign", IsJordanDesignWithCardinality );

DeclareCategory( "IsSpecialBoundJordanDesign", IsRegularSchemeJordanDesign );

DeclareCategory( "IsAssociationSchemeJordanDesign", IsSpecialBoundJordanDesign );

DeclareCategory( "IsTightJordanDesign", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignCardinality", IsJordanDesignWithAngleSet );

DeclareOperation( "JordanDesignAddCardinality", [ IsJordanDesignWithAngleSet, IsInt ] );

DeclareCategory( "IsJordanDesignWithStrength", IsJordanDesign );

DeclareAttribute( "JordanDesignAnnihilatorPolynomial", IsJordanDesignWithAngleSet and IsJordanDesignWithCardinality );

DeclareAttribute( "JordanDesignIndicatorCoefficients", IsJordanDesignWithAngleSet and IsJordanDesignWithCardinality );

DeclareAttribute( "JordanDesignStrength", IsJordanDesignWithAngleSet and IsJordanDesignWithCardinality );

DeclareAttribute( "JordanDesignSubdegrees", IsRegularSchemeJordanDesign );

DeclareAttribute( "JordanDesignIntersectionNumbers", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignReducedAdjacencyMatrices", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignBoseMesnerAlgebra", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignBoseMesnerIdempotentBasis", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignFirstEigenmatrix", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignSecondEigenmatrix", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignMultiplicities", IsAssociationSchemeJordanDesign );

DeclareAttribute( "DesignValencies", IsAssociationSchemeJordanDesign );

DeclareAttribute( "JordanDesignKreinNumbers", IsAssociationSchemeJordanDesign );

# Octonion Lattice Tools

DeclareGlobalFunction( "IsLeechLatticeGramMatrix" );

DeclareGlobalFunction( "IsGossetLatticeGramMatrix" );

DeclareCategory( "IsOctonionLattice", IsFreeLeftModule );

    DeclareAttribute( "UnderlyingOctonionRing", IsOctonionLattice );

    DeclareAttribute( "UnderlyingOctonionRingBasis", IsOctonionLattice );
    
    DeclareAttribute( "OctonionGramMatrix", IsOctonionLattice );

    DeclareAttribute( "GeneratorsAsCoefficients", IsOctonionLattice );

    DeclareAttribute( "LLLReducedBasisCoefficients", IsOctonionLattice );

    DeclareAttribute( "GramMatrix", IsOctonionLattice );

    DeclareAttribute( "TotallyIsotropicCode", IsOctonionLattice );

DeclareGlobalFunction( "OctonionLatticeByGenerators" );

DeclareCategory( "IsOctonionLatticeBasis", IsCanonicalBasis );

    DeclareAttribute( "UnderlyingOctonionRing", IsOctonionLatticeBasis );

DeclareOperation( "IsSublattice", [ IsOctonionLattice, IsOctonionLattice ] );

DeclareOperation( "Coefficients", [ IsOctonionLatticeBasis,
      IsOctonionCollection ] );

# Other Tools

DeclareGlobalFunction( "Closure" );

DeclareGlobalFunction( "RandomElementClosure" );

DeclareGlobalFunction( "RandomOrbitOnSets" );