Add `check_foreach(...)` function that does multiple checks at once on an array or matrix

Offen
  • Stimmt etwas nicht?
#3,417 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
cpp
Bereich
backend

Rechercherichtung

Start by reading the existing check_not_nan, check_positive, and check_finite implementations, including their vectorized overloads and index-reporting behavior. Define the lambda interfaces and confirm how check_foreach should handle arrays and Eigen matrices; it is done when one traversal performs all requested checks while preserving the failing index in errors.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

code cleanup new function

Often we have code that does a series of checks on an std::vector or Eigen matrix like the following

   check_not_nan(function, "log odds parameter", beta);    
   check_positive(function, "log odds parameter", beta);
   check_finite(function, "log odds parameter", beta);

The issue is that this causes three separate passes over beta. If beta is a large vector this can be kind of expensive.

We could make this nicer via one of two schems

  1. Just use a loop for these types of checks
for (auto&& beta_i : beta) 
   check_not_nan(function, "log odds parameter", beta_i);    
   check_positive(function, "log odds parameter", beta_i);
   check_finite(function, "log odds parameter", beta_i);
}

But then we lose the nice information that the vectorized checks do where it also tells us what index caused the errors.

  1. A check_foreach function that checks multiple things at every line.
    For this we would also need lambdas for each of the check functions. The user would call something like this
check_foreach(function, "log odds parameter", beta, check_not_nan_p, check_positive_p, check_finite_p);

Under the hood this would expand into a loop that handles all of the indexing so that the end error still has the correct index information.

for (Eigen::Index = 0; i < x.size(); i++) {
  check_not_nan_p(function, name, x[i], i);  
  check_positive_p(function, name, x[i], i);  
  check_finite_p(function, name, x[i], i);  
}

So then we only do one pass over the memory and still get the pretty checks

Vorherrschende Sprache
C++
Sterne
845
Forks
225
Ø Merge
3 T. 9 Std.
Gemergte PRs (30 T.)
12

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus stan-dev/math

Alle Issues in stan-dev/math

Ähnliche Issues

Weitere Issues zu C++

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.