Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] authored and dmitry-kabanov committed Feb 10, 2025
1 parent 5c24219 commit 192d886
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 20 deletions.
1 change: 0 additions & 1 deletion docs/source/api/api-c/ivp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@ ivp
===

.. doxygenfile:: oif/interfaces/ivp.h

1 change: 0 additions & 1 deletion docs/source/api/api-c/linsolve.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@ linsolve
========

.. doxygenfile:: oif/interfaces/linsolve.h

3 changes: 0 additions & 3 deletions docs/source/api/api-python/ivp/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,3 @@ Module Contents
.. py:method:: print_stats()
Print integration statistics.



3 changes: 0 additions & 3 deletions docs/source/api/api-python/linear_solver/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,3 @@ Module Contents
:returns: Result of the linear system solution after the invocation
of the `solve` method.
:rtype: np.ndarray



3 changes: 0 additions & 3 deletions docs/source/api/api-python/qeq_solver/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,3 @@ Module Contents
.. py:method:: solve(a: float, b: float, c: float)
Solve the quadratic equation :math:`a x^2 + b x + c = 0`.



1 change: 0 additions & 1 deletion docs/source/api/c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ C Interfaces
api-c/ivp.rst
api-c/linsolve.rst
api-c/qeq.rst

6 changes: 4 additions & 2 deletions oif/interfaces/c/include/oif/interfaces/ivp.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/**
* @file
* @brief Interface for solving initial-value problems (IVP) for ordinary differential equations (ODE).
* @brief Interface for solving initial-value problems (IVP) for ordinary differential
* equations (ODE).
*
* This interface defines the interface for solving initial-value problems
* for ordinary differential equations:
Expand All @@ -23,7 +24,8 @@ extern "C" {
*
* @param[in] t Current time
* @param[in] y State vector at time `t`
* @param[out] ydot Derivative of the state vector, which must be computed during the function call
* @param[out] ydot Derivative of the state vector, which must be computed during the function
* call
* @param[in] user_data User data (additional context) required by the right-hand side function
*/
typedef int (*oif_ivp_rhs_fn_t)(double t, OIFArrayF64 *y, OIFArrayF64 *ydot, void *user_data);
Expand Down
4 changes: 2 additions & 2 deletions oif/interfaces/c/include/oif/interfaces/linsolve.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* @file
* This module defines the interface for solving linear systems of equations.
*
*
* Problems to be solved are of the form:
*
*
* \f[
* A x = b,
* \f]
Expand Down
8 changes: 4 additions & 4 deletions oif/interfaces/c/include/oif/interfaces/qeq.h
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
/**
* @file
* This module defines the interface for solving a quadratic equation.
*
*
* The quadratic equation is of the form:
* \f[
* a x^2 + b x + c = 0,
* \f]
* where \f$a\f$, \f$b\f$, and \f$c\f$ are the coefficients of the equation.
*
*
* Of course, this is not very useful in scientific context to invoke
* such a solver.
*
*
* It was developed as a prototype to ensure that the envisioned architecture
* of Open Interfaces is feasible.
* It is used as a simple text case as well.
*
*
*/
#pragma once

Expand Down

0 comments on commit 192d886

Please sign in to comment.