You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ where `TARGET_NAME` is the name of your library/executable.
37
37
38
38
All functiononality can be included with `#include <finitediff.hpp>`.
39
39
40
-
The library provides three main function`finite_gradient`, `finite_jacobian`, and `finite_hessian`.
40
+
The library provides three main functions`finite_gradient`, `finite_jacobian`, and `finite_hessian`.
41
41
42
42
#### `finite_gradient`:
43
43
@@ -93,11 +93,11 @@ enum AccuracyOrder {
93
93
94
94
#### `eps`:
95
95
96
-
The parameter `eps` is the finite difference step size. Smaller values result in a more accuracate approximation, but too small of a value can result in large numerical error because the difference will be divided by a small number.
96
+
The parameter `eps` is the finite difference step size. Smaller values result in a more accurate approximation, but too small of a value can result in a large numerical error because the difference will be divided by a small number.
97
97
98
98
## Dependencies
99
99
100
-
**All dependancies are downloaded through CMake** depending on the build options.
100
+
**All dependencies are downloaded through CMake** depending on the build options.
101
101
The following libraries are used in this project:
102
102
103
103
*[Eigen](https://eigen.tuxfamily.org/): linear algebra
@@ -110,13 +110,13 @@ The following libraries are used in this project:
110
110
## <aname="unit_tests"></a>Unit Tests
111
111
112
112
We provide unit tests for ensuring the correctness of our functions.
113
-
To enable the unit tests use the flag `-DFINITE_DIFF_BUILD_UNIT_TESTS=ON` with CMake.
113
+
To enable the unit tests, use the flag `-DFINITE_DIFF_BUILD_UNIT_TESTS=ON` with CMake.
114
114
115
115
## Contributing
116
116
117
-
This project is open for contributors! Contibutions can come in the form of feature requests, bug fixes, documentation, tutorials and the like. We highly recommend to file an Issue first before submitting a Pull Request.
117
+
This project is open to contributors! Contributions can come in the form of feature requests, bug fixes, documentation, tutorials and the like. We highly recommend filing an Issue first before submitting a Pull Request.
118
118
119
-
Simply fork this repository and make a Pull Request! We'd definitely appreciate:
119
+
Simply fork this repository and make a Pull Request! We'd appreciate:
0 commit comments