Skip to content

Commit ac6c8d3

Browse files
author
alexeev-prog
committed
docs/fix: update docs, fix example
1 parent a6a9ec4 commit ac6c8d3

File tree

7 files changed

+24
-21
lines changed

7 files changed

+24
-21
lines changed

CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ include(cmake/prelude.cmake)
44

55
project(
66
libnumerixpp
7-
VERSION 0.1.2
7+
VERSION 0.1.3
88
DESCRIPTION "A Powerful C++ Library for High-Performance Numerical Computing"
9-
HOMEPAGE_URL "https://alxvdev.github.io/libnumerixpp"
9+
HOMEPAGE_URL "https://alexeev-prog.github.io/libnumerixpp"
1010
LANGUAGES CXX
1111
)
1212

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = "libnumerixpp"
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = "0.1.2"
51+
PROJECT_NUMBER = "0.1.3"
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,22 @@ You can join to our [small russian telegram blog](https://t.me/hex_warehouse).
3232

3333
> You can view docs for libnumerixpp [here](https://alexeev-prog.github.io/libnumerixpp).
3434
35-
> Current version: 0.1.2
35+
> Current version: 0.1.3
36+
37+
## Comparison to Alternatives 🤔
38+
To help you decide whether libnumerixpp is the right choice for your project, here's a comparison table with some popular numerical computation libraries:
39+
40+
| Feature | libnumerixpp | Eigen | Boost.Numeric | LAPACK |
41+
| --- | --- | --- | --- | --- |
42+
| Multi-disciplinary Approach |||||
43+
| Equation Solving |||||
44+
| Statistical Functions |||||
45+
| Kinematics Calculations |||||
46+
| Number System Conversion |||||
47+
| Doxygen Documentation |||||
48+
| Unit Tests |||||
49+
| Cross-platform Support |||||
50+
As you can see, libnumerixpp offers a unique combination of features that sets it apart from other popular numerical computation libraries. Its multi-disciplinary approach, comprehensive functionality, and robust infrastructure make it a compelling choice for a wide range of projects.
3651

3752
## Key Features 🔑
3853
The libnumerixpp library boasts an impressive array of features that set it apart from its competitors:
@@ -59,21 +74,6 @@ Robust Infrastructure:
5974
- CMake build system 🛠️ for cross-platform compatibility and easy installation
6075
- clang-format code formatting 💅 for consistent and readable code
6176

62-
## Comparison to Alternatives 🤔
63-
To help you decide whether libnumerixpp is the right choice for your project, here's a comparison table with some popular numerical computation libraries:
64-
65-
| Feature | libnumerixpp | Eigen | Boost.Numeric | LAPACK |
66-
| --- | --- | --- | --- | --- |
67-
| Multi-disciplinary Approach |||||
68-
| Equation Solving |||||
69-
| Statistical Functions |||||
70-
| Kinematics Calculations |||||
71-
| Number System Conversion |||||
72-
| Doxygen Documentation |||||
73-
| Unit Tests |||||
74-
| Cross-platform Support |||||
75-
As you can see, libnumerixpp offers a unique combination of features that sets it apart from other popular numerical computation libraries. Its multi-disciplinary approach, comprehensive functionality, and robust infrastructure make it a compelling choice for a wide range of projects.
76-
7777
## Getting Started 🚀
7878

7979
To get started with libnumerixpp, follow these simple steps:

SECURITY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ currently being supported with security updates.
77

88
| Version | Supported |
99
| ------- | ------------------ |
10+
| 0.1.3 | :white_check_mark: |
1011
| 0.1.2 | :white_check_mark: |
1112
| 0.1.1 | :x: |
1213
| 0.1.0 | :x: |

docs/ru/article3.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131

3232
Можно использовать свой README для ответа на другие вопросы. Например, дальнейшие цели в развитии проекта, информация о лицензиях, важных изменениях в коде.
3333

34+
Для этого можно использовать даже ChatGPT, да простит меня хабро-бог за эту фразу.
35+
3436
## Содержание
3537

3638
+ [Первая часть](https://habr.com/ru/companies/timeweb/articles/845074/)

examples/example-4.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ void test_eq_sa(double (*f_eq)(double), double x0, const std::string &eq) {
1313

1414
std::cout << "Equation solution " << eq << ":\t";
1515

16-
z = mathematics::equations::successiveApproximationsFindingRoot(f_eq, x0, iterations);
16+
z = mathematics::equations::successive_approximations_finding_root(f_eq, x0, iterations);
1717

1818
std::cout << z << '\n';
1919

src/libnumerixpp.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @file
33
* @brief A Powerful C++ Library for High-Performance Numerical Computing
4-
* @version 0.1.2
4+
* @version 0.1.3
55
* @date 2024-09-21
66
* @authors alxvdev
77
* @copyright Apache 2.0 License

0 commit comments

Comments
 (0)