rename nq to q

Author: HugoMVale

c/example/example3.c

@@ -9,7 +9,7 @@ This is a translation of example 3 from the ODRPACK95 documentation.
 #include "../include/odrpack/odrpack.h"
 
 // User-supplied function for evaluating the model
-void fcn(const int *n, const int *m, const int *np, const int *nq,
+void fcn(const int *n, const int *m, const int *np, const int *q,
          const double beta[], const double xplusd[],
          const int ifixb[], const int ifixx[], const int *ldifx, const int *ideval,
          double f[], double fjacb[], double fjacd[], int *istop) {
@@ -47,12 +47,12 @@ int main() {
 #define NP 5
 #define N 23
 #define M 1
-#define NQ 2
+#define Q 2
 
     // Variable declarations
-    int n = N, m = M, np = NP, nq = NQ;
-    int ldwe = N, ld2we = NQ, ldwd = N, ld2wd = M, ldifx = N;
-    double beta[NP], x[M][N], y[NQ][N], delta[M][N], wd[M][M][N], we[NQ][NQ][N];
+    int n = N, m = M, np = NP, q = Q;
+    int ldwe = N, ld2we = Q, ldwd = N, ld2wd = M, ldifx = N;
+    double beta[NP], x[M][N], y[Q][N], delta[M][N], wd[M][M][N], we[Q][Q][N];
     int ifixx[M][N];
     int ifixb[NP] = {1, 1, 1, 1, 1};
     int iscan = 0;
@@ -85,7 +85,7 @@ int main() {
                 return 1;
             }
         }
-        for (int j = 0; j < nq; j++) {
+        for (int j = 0; j < q; j++) {
             iscan = fscanf(data_file, "%lf", &y[j][i]);
             if (iscan != 1) {
                 fprintf(stderr, "Error reading y values\n");
@@ -144,7 +144,7 @@ int main() {
     int info = 0;
 
     // Compute solution
-    odr_medium_c(fcn, &n, &m, &np, &nq,
+    odr_medium_c(fcn, &n, &m, &np, &q,
                  &ldwe, &ld2we, &ldwd, &ld2wd, &ldifx,
                  beta,
                  (double *)y, (double *)x,

c/example/example5.c

@@ -10,7 +10,7 @@ This is an adaptation of example 5 from the ODRPACK95 documentation.
 #include "../include/odrpack/odrpack.h"
 
 // User-supplied function for evaluating the model and its partial derivatives
-void fcn(const int *n, const int *m, const int *np, const int *nq,
+void fcn(const int *n, const int *m, const int *np, const int *q,
          const double beta[], const double xplusd[],
          const int ifixb[], const int ifixx[], const int *ldifx, const int *ideval,
          double f[], double fjacb[], double fjacd[], int *istop) {
@@ -43,7 +43,7 @@ int main() {
 #define NP 2
 #define N 4
 #define M 1
-#define NQ 1
+#define Q 1
 #define LDWE 1
 #define LD2WE 1
 #define LDWD 1
@@ -52,16 +52,16 @@ int main() {
 #define LDSTPD 1
 #define LDSCLD 1
 
-    int n = N, m = M, np = NP, nq = NQ;
+    int n = N, m = M, np = NP, q = Q;
     double beta[NP] = {2.0, 0.5};
     double lower[NP] = {0.0, 0.0};
     double upper[NP] = {10.0, 0.9};
     double x[M][N] = {{0.982, 1.998, 4.978, 6.01}};
-    double y[NQ][N] = {{2.7, 7.4, 148.0, 403.0}};
+    double y[Q][N] = {{2.7, 7.4, 148.0, 403.0}};
     double delta[M][N] = {{0.0, 0.0, 0.0, 0.0}};
 
     int ldwe = LDWE, ld2we = LD2WE, ldwd = LDWD, ld2wd = LD2WD;
-    double we[NQ][LD2WE][LDWE] = {{{-1.0}}};
+    double we[Q][LD2WE][LDWE] = {{{-1.0}}};
     double wd[M][LD2WE][LDWD] = {{{-1.0}}};
 
     int ldifx = LDIFX;
@@ -88,7 +88,7 @@ int main() {
 
     // Determine workspace requirements
     int lwork, liwork;
-    workspace_dimensions_c(&n, &m, &np, &nq, &isodr, &lwork, &liwork);
+    workspace_dimensions_c(&n, &m, &np, &q, &isodr, &lwork, &liwork);
     // printf("lwork: %d\n", lwork);
     // printf("liwork: %d\n", liwork);
 
@@ -114,7 +114,7 @@ int main() {
     lunerr = lunrpt;
 
     // Call odr
-    odr_long_c(fcn, &n, &m, &np, &nq,
+    odr_long_c(fcn, &n, &m, &np, &q,
                &ldwe, &ld2we, &ldwd, &ld2wd,
                &ldifx, &ldstpd, &ldscld,
                &lwork, &liwork,
@@ -137,8 +137,8 @@ int main() {
     // Get the variable locations within the integer and real work space
     iworkidx_t iworkidx;
     workidx_t workidx;
-    loc_iwork_c(&m, &np, &nq, &iworkidx);
-    loc_rwork_c(&n, &m, &np, &nq, &ldwe, &ld2we, &isodr, &workidx);
+    loc_iwork_c(&m, &np, &q, &iworkidx);
+    loc_rwork_c(&n, &m, &np, &q, &ldwe, &ld2we, &isodr, &workidx);
 
     // Print some outputs
     printf("info: %d\n", info);

c/include/odrpack/odrpack.h

@@ -37,16 +37,16 @@ ODRPACK_EXTERN void close_file(
  * @param n       `==>` Number of observations.
  * @param m       `==>` Number of columns of data in the independent variable.
  * @param np      `==>` Number of function parameters.
- * @param nq      `==>` Number of responses per observation.
+ * @param q       `==>` Number of responses per observation.
  * @param beta    `==>` Array [np] of current parameter values.
  * @param xplusd  `==>` Array [m][ldn] of current explanatory variable values, i.e., `x + delta`.
  * @param ifixb   `==>` Array [np] of indicators for fixing parameters `beta`.
  * @param ifixx   `==>` Array [m][ldifx] of indicators for fixing explanatory variable `x`.
  * @param ldifx   `==>` Leading dimension of array `ifixx`, `ifixx ∈ {1, n}`
  * @param ideval  `==>` Indicator for selecting computation to be performed.
- * @param f       `<==` Array [nq][n] for predicted function values.
- * @param fjacb   `<==` Array [nq][np][n] for Jacobian with respect to `beta`.
- * @param fjacd   `<==` Array [nq][m][n] for Jacobian with respect to errors `delta`.
+ * @param f       `<==` Array [q][n] for predicted function values.
+ * @param fjacb   `<==` Array [q][np][n] for Jacobian with respect to `beta`.
+ * @param fjacd   `<==` Array [q][m][n] for Jacobian with respect to errors `delta`.
  * @param istop   `<==` Integer for stopping condition. Values:
  *                0 - current `beta` and `x + delta` were acceptable and values were computed successfully,
  *                1 - current `beta` and `x + delta` are not acceptable; ODRPACK95 should select values closer to most recently used values if possible,
@@ -56,7 +56,7 @@ typedef void (*odrpack_fcn_t)(
     const int *n,
     const int *m,
     const int *np,
-    const int *nq,
+    const int *q,
     const double beta[],
     const double xplusd[],
     const int ifixb[],
@@ -76,9 +76,9 @@ typedef void (*odrpack_fcn_t)(
  * @param n      `==>` Number of observations.
  * @param m      `==>` Number of columns of data in the independent variable.
  * @param np     `==>` Number of function parameters.
- * @param nq     `==>` Number of responses per observation.
+ * @param q      `==>` Number of responses per observation.
  * @param beta   `<=>` Array [np] of function parameters.
- * @param y      `==>` Array [nq][n] of dependent variable. Unused when the model is implicit.
+ * @param y      `==>` Array [q][n] of dependent variable. Unused when the model is implicit.
  * @param x      `==>` Array [m][n] of explanatory variable.
  * @param delta  `<=>` Optional array [m][n] with initial error in the `x` data.
  * @param lower  `==>` Optional array [np] with lower bound on `beta`.
@@ -90,7 +90,7 @@ ODRPACK_EXTERN void odr_short_c(
     const int *n,
     const int *m,
     const int *np,
-    const int *nq,
+    const int *q,
     double beta[],
     const double y[],
     const double x[],
@@ -107,16 +107,16 @@ ODRPACK_EXTERN void odr_short_c(
  * @param n      `==>` Number of observations.
  * @param m      `==>` Number of columns of data in the independent variable.
  * @param np     `==>` Number of function parameters.
- * @param nq     `==>` Number of responses per observation.
+ * @param q     `==>` Number of responses per observation.
  * @param ldwe   `==>` Leading dimension of array `we`, `ldwe ∈ {1, n}`.
- * @param ld2we  `==>` Second dimension of array `we`, `ld2we ∈ {1, nq}`.
+ * @param ld2we  `==>` Second dimension of array `we`, `ld2we ∈ {1, q}`.
  * @param ldwd   `==>` Leading dimension of array `wd`, `ldwd ∈ {1, n}`.
  * @param ld2wd  `==>` Second dimension of array `wd`, `ld2wd ∈ {1, m}`.
  * @param ldifx  `==>` Leading dimension of array `ifixx`, `ldifx ∈ {1, n}`.
  * @param beta   `<=>` Array [np] of function parameters.
- * @param y      `==>` Array [nq][n] of dependent variable. Unused when the model is implicit.
+ * @param y      `==>` Array [q][n] of dependent variable. Unused when the model is implicit.
  * @param x      `==>` Array [m][n] of explanatory variable.
- * @param we     `==>` Optional array [nq][ld2we][ldwe] with `epsilon` weights.
+ * @param we     `==>` Optional array [q][ld2we][ldwe] with `epsilon` weights.
  * @param wd     `==>` Optional array [m][ld2wd][ldwd] with `delta` weights.
  * @param ifixb  `==>` Optional array [np] with values designating whether the elements of `beta` are fixed at their input values or not.
  * @param ifixx  `==>` Optional array [m][ldifx] with values designating whether the elements of `x` are fixed at their input values or not.
@@ -134,7 +134,7 @@ ODRPACK_EXTERN void odr_medium_c(
     const int *n,
     const int *m,
     const int *np,
-    const int *nq,
+    const int *q,
     const int *ldwe,
     const int *ld2we,
     const int *ldwd,
@@ -164,9 +164,9 @@ ODRPACK_EXTERN void odr_medium_c(
  * @param n      `==>` Number of observations.
  * @param m      `==>` Number of columns of data in the independent variable.
  * @param np     `==>` Number of function parameters.
- * @param nq     `==>` Number of responses per observation.
+ * @param q     `==>` Number of responses per observation.
  * @param ldwe   `==>` Leading dimension of array `we`, `ldwe ∈ {1, n}`.
- * @param ld2we  `==>` Second dimension of array `we`, `ld2we ∈ {1, nq}`.
+ * @param ld2we  `==>` Second dimension of array `we`, `ld2we ∈ {1, q}`.
  * @param ldwd   `==>` Leading dimension of array `wd`, `ldwd ∈ {1, n}`.
  * @param ld2wd  `==>` Second dimension of array `wd`, `ld2wd ∈ {1, m}`.
  * @param ldifx  `==>` Leading dimension of array `ifixx`, `ldifx ∈ {1, n}`.
@@ -175,9 +175,9 @@ ODRPACK_EXTERN void odr_medium_c(
  * @param lwork  `==>` Length of array `work`.
  * @param liwork `==>` Length of array `iwork`.
  * @param beta   `<=>` Array [np] of function parameters.
- * @param y      `==>` Array [nq][n] of dependent variable. Unused when the model is implicit.
+ * @param y      `==>` Array [q][n] of dependent variable. Unused when the model is implicit.
  * @param x      `==>` Array [m][n] of explanatory variable.
- * @param we     `==>` Optional array [nq][ld2we][ldwe] with `epsilon` weights.
+ * @param we     `==>` Optional array [q][ld2we][ldwe] with `epsilon` weights.
  * @param wd     `==>` Optional array [m][ld2wd][ldwd] with `delta` weights.
  * @param ifixb  `==>` Optional array [np] with values designating whether the elements of `beta` are fixed at their input values or not.
  * @param ifixx  `==>` Optional array [m][ldifx] with values designating whether the elements of `x` are fixed at their input values or not.
@@ -206,7 +206,7 @@ ODRPACK_EXTERN void odr_long_c(
     const int *n,
     const int *m,
     const int *np,
-    const int *nq,
+    const int *q,
     const int *ldwe,
     const int *ld2we,
     const int *ldwd,
@@ -337,13 +337,13 @@ typedef struct
  *
  * @param m        `==>` Number of columns of data in the explanatory variable.
  * @param np       `==>` Number of function parameters.
- * @param nq       `==>` Number of responses per observation.
+ * @param q        `==>` Number of responses per observation.
  * @param iworkidx `<==` 0-based indexes of integer work array.
  */
 ODRPACK_EXTERN void loc_iwork_c(
     const int *m,
     const int *np,
-    const int *nq,
+    const int *q,
     iworkidx_t *iworkidx);
 
 /**
@@ -352,7 +352,7 @@ ODRPACK_EXTERN void loc_iwork_c(
  * @param n       `==>` Number of observations.
  * @param m       `==>` Number of columns of data in the explanatory variable.
  * @param np      `==>` Number of function parameters.
- * @param nq      `==>` Number of responses per observation.
+ * @param q       `==>` Number of responses per observation.
  * @param ldwe    `==>` Leading dimension of array `we`.
  * @param ld2we   `==>` Second dimension of array `we`.
  * @param isodr   `==>` Variable designating whether the solution is by ODR (`isodr=.true.`) or by OLS (`isodr=.false.`).
@@ -362,7 +362,7 @@ ODRPACK_EXTERN void loc_rwork_c(
     const int *n,
     const int *m,
     const int *np,
-    const int *nq,
+    const int *q,
     const int *ldwe,
     const int *ld2we,
     const bool *isodr,
@@ -374,7 +374,7 @@ ODRPACK_EXTERN void loc_rwork_c(
  * @param n      `==>` Number of observations.
  * @param m      `==>` Number of columns of data in the explanatory variable.
  * @param np     `==>` Number of function parameters.
- * @param nq     `==>` Number of responses per observation.
+ * @param q      `==>` Number of responses per observation.
  * @param isodr  `==>` Variable designating whether the solution is by ODR (`isodr=.true.`) or by OLS (`isodr=.false.`).
  * @param lwork  `<==` Length of real `work` array.
  * @param liwork `<==` Length of integer `iwork` array.
@@ -383,7 +383,7 @@ ODRPACK_EXTERN void workspace_dimensions_c(
     const int *n,
     const int *m,
     const int *np,
-    const int *nq,
+    const int *q,
     const bool *isodr,
     int *lwork,
     int *liwork);

example/example1.f90

@@ -7,13 +7,13 @@ module example1_model
 contains
 
    pure subroutine fcn( &
-      n, m, np, nq, beta, xplusd, ifixb, ifixx, ldifx, ideval, f, fjacb, fjacd, istop)
+      n, m, np, q, beta, xplusd, ifixb, ifixx, ldifx, ideval, f, fjacb, fjacd, istop)
    !! User-supplied subroutine for evaluating the model.
 
-      integer, intent(in) :: ideval, ldifx, m, n, np, nq
+      integer, intent(in) :: ideval, ldifx, m, n, np, q
       integer, intent(in) :: ifixb(np), ifixx(ldifx, m)
       real(kind=wp), intent(in) :: beta(np), xplusd(n, m)
-      real(kind=wp), intent(out) :: f(n, nq), fjacb(n, np, nq), fjacd(n, m, nq)
+      real(kind=wp), intent(out) :: f(n, q), fjacb(n, np, q), fjacd(n, m, q)
       integer, intent(out) :: istop
 
       ! Local variables
@@ -29,14 +29,14 @@ pure subroutine fcn( &
 
       ! Compute predicted values
       if (mod(ideval, 10) >= 1) then
-      do i = 1, nq
+      do i = 1, q
          f(:, i) = beta(1) + beta(2)*(exp(beta(3)*xplusd(:, 1)) - one)**2
       end do
       end if
 
       ! Compute derivatives with respect to 'beta'
       if (mod(ideval/10, 10) >= 1) then
-      do i = 1, nq
+      do i = 1, q
          fjacb(:, 1, i) = one
          fjacb(:, 2, i) = (exp(beta(3)*xplusd(:, 1)) - one)**2
          fjacb(:, 3, i) = beta(2)*2*(exp(beta(3)*xplusd(:, 1)) - one)*exp(beta(3)*xplusd(:, 1))*xplusd(:, 1)
@@ -45,7 +45,7 @@ pure subroutine fcn( &
 
       ! Compute derivatives with respect to 'delta'
       if (mod(ideval/100, 10) >= 1) then
-      do i = 1, nq
+      do i = 1, q
          fjacd(:, 1, i) = beta(2)*2*(exp(beta(3)*xplusd(:, 1)) - one)*exp(beta(3)*xplusd(:, 1))*beta(3)
       end do
       end if
@@ -56,14 +56,14 @@ end module example1_model
 
 program example1
 !! Explicit ODR job, with user-supplied analytic derivatives and nondefault `ifixx`.
-    
+
    use odrpack, only: odr
    use odrpack_kinds, only: wp
    use example1_model, only: fcn
    implicit none
 
    ! Variable declarations
-   integer :: i, info, iprint, j, job, lundata, lunrpt, m, n, np, nq
+   integer :: i, info, iprint, j, job, lundata, lunrpt, m, n, np, q
    integer, allocatable :: ifixx(:, :)
    real(kind=wp), allocatable :: beta(:), x(:, :), y(:, :)
 
@@ -72,15 +72,15 @@ program example1
 
    ! Read problem dimensions
    open (newunit=lundata, file='./example/data1.dat')
-   read (lundata, *) n, m, np, nq
+   read (lundata, *) n, m, np, q
 
    ! Allocate arrays
-   allocate (beta(np), x(n, m), y(n, nq), ifixx(n, m))
+   allocate (beta(np), x(n, m), y(n, q), ifixx(n, m))
 
    ! Read problem data and set nondefault value for argument 'ifixx'
    read (lundata, *) (beta(i), i=1, np)
    do i = 1, n
-      read (lundata, *) (x(i, j), j=1, m), (y(i, j), j=1, nq)
+      read (lundata, *) (x(i, j), j=1, m), (y(i, j), j=1, q)
       if (x(i, 1) == 0.0E0_wp .or. x(i, 1) == 100.0E0_wp) then
          ifixx(i, 1) = 0
       else
@@ -102,7 +102,7 @@ program example1
 
    ! Compute solution
    call odr(fcn=fcn, &
-            n=n, m=m, np=np, nq=nq, &
+            n=n, m=m, np=np, q=q, &
             beta=beta, &
             y=y, x=x, &
             ifixx=ifixx, &