You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doc_BoxAlgorithm_MatrixValidityChecker.dox-part 1.9KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. /**
  2. * \page BoxAlgorithm_MatrixValidityChecker Matrix validity checker
  3. __________________________________________________________________
  4. Detailed description
  5. __________________________________________________________________
  6. * |OVP_DocBegin_BoxAlgorithm_MatrixValidityChecker_Description|
  7. Ensures values stored in a matrix are valid, i.e. regular floating point values as opposed to NaN (not a number) or infinite.
  8. * |OVP_DocEnd_BoxAlgorithm_MatrixValidityChecker_Description|
  9. __________________________________________________________________
  10. Inputs description
  11. __________________________________________________________________
  12. * |OVP_DocBegin_BoxAlgorithm_MatrixValidityChecker_Inputs|
  13. * |OVP_DocEnd_BoxAlgorithm_MatrixValidityChecker_Inputs|
  14. * |OVP_DocBegin_BoxAlgorithm_MatrixValidityChecker_Input1|
  15. * |OVP_DocEnd_BoxAlgorithm_MatrixValidityChecker_Input1|
  16. __________________________________________________________________
  17. Settings description
  18. __________________________________________________________________
  19. * |OVP_DocBegin_BoxAlgorithm_MatrixValidityChecker_Settings|
  20. * |OVP_DocEnd_BoxAlgorithm_MatrixValidityChecker_Settings|
  21. * |OVP_DocBegin_BoxAlgorithm_MatrixValidityChecker_Setting1|
  22. Log level of messages to be printed whenever Nan or infinite values are found in input matrix.
  23. * |OVP_DocEnd_BoxAlgorithm_MatrixValidityChecker_Setting1|
  24. __________________________________________________________________
  25. Examples description
  26. __________________________________________________________________
  27. * |OVP_DocBegin_BoxAlgorithm_MatrixValidityChecker_Examples|
  28. * |OVP_DocEnd_BoxAlgorithm_MatrixValidityChecker_Examples|
  29. __________________________________________________________________
  30. Miscellaneous description
  31. __________________________________________________________________
  32. * |OVP_DocBegin_BoxAlgorithm_MatrixValidityChecker_Miscellaneous|
  33. * |OVP_DocEnd_BoxAlgorithm_MatrixValidityChecker_Miscellaneous|
  34. */