https://github.com/singularitti/conjugategradient.jl

A Julia package for solving linear systems and optimization problems using the Conjugate Gradient method
https://github.com/singularitti/conjugategradient.jl

conjugate-gradient iterative-methods julia julia-package numerical-methods optimization-algorithms

Last synced: 9 months ago
JSON representation

A Julia package for solving linear systems and optimization problems using the Conjugate Gradient method

• Host: GitHub
• URL: https://github.com/singularitti/conjugategradient.jl
• Owner: singularitti
• License: mit
• Created: 2023-11-10T08:39:54.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-18T07:19:30.000Z (over 1 year ago)
• Last Synced: 2025-04-06T10:42:13.416Z (about 1 year ago)
• Topics: conjugate-gradient, iterative-methods, julia, julia-package, numerical-methods, optimization-algorithms
• Language: Julia
• Homepage: https://singularitti.github.io/ConjugateGradient.jl/
• Size: 331 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ConjugateGradient

| **Documentation** | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://singularitti.github.io/ConjugateGradient.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://singularitti.github.io/ConjugateGradient.jl/dev/)                                                                                                                                                                                                                                                                                                 |

| :---------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| **Build Status**  | [![Build Status](https://github.com/singularitti/ConjugateGradient.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/singularitti/ConjugateGradient.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Build Status](https://ci.appveyor.com/api/projects/status/github/singularitti/ConjugateGradient.jl?svg=true)](https://ci.appveyor.com/project/singularitti/ConjugateGradient-jl)[![Build Status](https://api.cirrus-ci.com/github/singularitti/ConjugateGradient.jl.svg)](https://cirrus-ci.com/github/singularitti/ConjugateGradient.jl) |

|   **Coverage**    | [![Coverage](https://github.com/singularitti/ConjugateGradient.jl/badges/main/coverage.svg)](https://github.com/singularitti/ConjugateGradient.jl/commits/main) [![Coverage](https://codecov.io/gh/singularitti/ConjugateGradient.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/singularitti/ConjugateGradient.jl)                                                                                                                                                                                                                |

|    **Others**     | [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![License](https://img.shields.io/github/license/singularitti/ConjugateGradient.jl)](https://github.com/singularitti/ConjugateGradient.jl/blob/main/LICENSE)                                                                                                                                                                                                                                                   |

The code, which is [hosted on GitHub](https://github.com/singularitti/ConjugateGradient.jl), is tested

using various continuous integration services for its validity.

This repository is created and maintained by

[@singularitti](https://github.com/singularitti), and contributions are highly welcome.

## Package features

## Installation

The package can be installed with the Julia package manager.

From [the Julia REPL](https://docs.julialang.org/en/v1/stdlib/REPL/), type `]` to enter

the [Pkg mode](https://docs.julialang.org/en/v1/stdlib/REPL/#Pkg-mode) and run:

```julia-repl

pkg> add ConjugateGradient

```

Or, equivalently, via [`Pkg.jl`](https://pkgdocs.julialang.org/v1/):

```julia

julia> import Pkg; Pkg.add("ConjugateGradient")

```

## Documentation

- [**STABLE**](https://singularitti.github.io/ConjugateGradient.jl/stable/) — **documentation of the most recently tagged version.**

- [**DEV**](https://singularitti.github.io/ConjugateGradient.jl/dev/) — _documentation of the in-development version._

## Project status

The package is developed for and tested against Julia `v1.6` and above on Linux, macOS, and

Windows.

## Questions and contributions

You can post usage questions on

[our discussion page](https://github.com/singularitti/ConjugateGradient.jl/discussions).

We welcome contributions, feature requests, and suggestions. If you encounter any problems,

please open an [issue](https://github.com/singularitti/ConjugateGradient.jl/issues).

The [Contributing](@ref) page has

a few guidelines that should be followed when opening pull requests and contributing code.