arithmoi 项目教程

arithmoi 项目教程

arithmoiNumber theory: primes, arithmetic functions, modular computations, special sequences项目地址:https://gitcode.com/gh_mirrors/ar/arithmoi

1. 项目的目录结构及介绍

arithmoi 项目的目录结构如下：

arithmoi/
├── src/
│   ├── Math/
│   │   └── NumberTheory/
│   │       ├── ArithmeticFunctions.hs
│   │       ├── Inverse.hs
│   │       ├── Mertens.hs
│   │       ├── Moebius.hs
│   │       ├── NFreedom.hs
│   │       ├── SmoothNumbers.hs
│   │       └── Zeta.hs
│   └── Linear.hs
├── test/
│   └── Spec.hs
├── arithmoi.cabal
├── LICENSE
├── README.md
└── Setup.hs

目录结构介绍

• src/: 包含项目的源代码文件，主要分为以下几个模块：
  • Math/NumberTheory/: 包含与数论相关的功能模块，如算术函数、逆元、默滕斯函数等。
  • Linear.hs: 包含与线性代数相关的功能模块。
• test/: 包含项目的测试代码文件，主要用于测试各个模块的功能。
• arithmoi.cabal: 项目的配置文件，定义了项目的依赖、构建信息等。
• LICENSE: 项目的许可证文件，说明项目的开源许可类型。
• README.md: 项目的说明文件，通常包含项目的简介、安装方法、使用说明等。
• Setup.hs: 项目的构建脚本，用于配置项目的构建过程。

2. 项目的启动文件介绍

arithmoi 项目没有明确的“启动文件”，因为它是一个库项目，主要提供各种数论相关的功能模块。用户在使用时，通常会根据需要导入特定的模块进行使用。

例如，如果用户需要使用数论中的算术函数，可以通过以下方式导入：

import Math.NumberTheory.ArithmeticFunctions

3. 项目的配置文件介绍

arithmoi 项目的主要配置文件是 arithmoi.cabal。该文件定义了项目的元数据、依赖关系、构建选项等信息。

arithmoi.cabal 文件内容示例

name:                arithmoi
version:             0.13.0.0
synopsis:            Efficient basic number-theoretic functions
description:         A library of basic functionality needed for number-theoretic calculations
license:             MIT
license-file:        LICENSE
author:              Carter Schonwald, Daniel Fischer, Herbert Valerio Riedel, Bodigrim
maintainer:          bodigrim@gmail.com
category:            Math, Algorithms, Number Theory
build-type:          Simple
cabal-version:       >=1.10

library
  exposed-modules:
    Math.NumberTheory.ArithmeticFunctions
    Math.NumberTheory.ArithmeticFunctions.Inverse
    Math.NumberTheory.ArithmeticFunctions.Mertens
    Math.NumberTheory.ArithmeticFunctions.Moebius
    Math.NumberTheory.ArithmeticFunctions.NFreedom
    Math.NumberTheory.ArithmeticFunctions.SmoothNumbers
    Math.NumberTheory.ArithmeticFunctions.Zeta
    Math.NumberTheory.Linear

  build-depends:
    base >=4.12 && <5,
    containers,
    deepseq,
    ghc-bignum,
    integer-gmp,
    random,
    transformers

  hs-source-dirs:      src
  default-language:    Haskell2010

test-suite spec
  type:                exitcode-stdio-1.0
  main-is:             Spec.hs
  hs-source-dirs:      test
  build-depends:
    base,
    arithmoi,
    hspec,
    QuickCheck
  default-language:    Haskell2010

配置文件介绍

• name: 项目的名称。
• version: 项目的版本号。
• synopsis: 项目的简短描述。
• description: 项目的详细描述。
• license: 项目的许可证类型。
• license-file: 许可证文件的路径。
• author: 项目的作者。
• maintainer: 项目的维护者。
• category: 项目的分类。
• build-type: 项目的构建类型。
• cabal-version: 所需的 Cabal 版本。
• library: 定义了项目的库部分，包括暴露的模块和构建依赖。
• test-suite: 定义了项目的测试套件，包括测试文件和依赖。

通过 arithmoi.cabal 文件，用户可以了解项目的依赖关系、构建方式以及如何使用项目中的各个模块。

arithmoiNumber theory: primes, arithmetic functions, modular computations, special sequences项目地址:https://gitcode.com/gh_mirrors/ar/arithmoi