max/ourMELONS
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Updated documentation

Browse source
This commit is contained in:
Waldir Leoncio 2020-01-15 17:05:45 +01:00
parent 6534d4fa4a
commit ab19ebd671
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
TODO.md
View file

@ -23,7 +23,15 @@ The list below contains non-essential but nice-to-have tasks for the next stable
# Known pitfalls # Known pitfalls
The following behavioral differences have been detected between the Matlab functions and their R counterparts. In order to save time, these differences will not be addressed, since they could require extensive reworking of a function. However, such differences may very well cause unexpected problems in some situations, which is why compiling this list is so important. The list below might provide a good starting point for identifying and fixing bugs: The following behavioral differences have been detected between the Matlab functions and their R counterparts. In order to save time, these differences will not be addressed, since they could require extensive reworking of a function. However, such differences may very well cause unexpected problems in some situations, which is why compiling this list is so important. The tables below might provide a good starting point for identifying and fixing bugs.
As general remarks, one should keep in mind that:
- For compliance with IEC 60559, the `round` in base R rounds .5 to the nearest even integer, whereas the homonym function in Matlab rounds up (or down, if negative).
- Some clobal variables have been added as a new (last) argument to the function they appear in.
- When a function is defined on Matlab with multiple outputs, as in `[y1, y2] = f(x)`, it will output only `y1` if called without assignment, as in `f(3)`, or if called with a one-length assignment, as in `a = f(3)`. In order to receive the full output, one must assign two variables to the left side of the assignment operator, as in `[a, b] = f(3)`. rBAPS Functions that might be affected by this behavior include `etsiParas`.
## Functional differences in rBAPS functions
| Function | Argument | Value | Matlab output | R output | | Function | Argument | Value | Matlab output | R output |
| ----------------- | ------------------ | -------------- | --------------------- | ------------------------------- | | ----------------- | ------------------ | -------------- | --------------------- | ------------------------------- |
@ -31,7 +39,8 @@ The following behavioral differences have been detected between the Matlab funct
| `ownNum2Str` | `number` | `<vector>` | `'<vector elements>'` | `'<vector elements>'` + warning | | `ownNum2Str` | `number` | `<vector>` | `'<vector elements>'` | `'<vector elements>'` + warning |
| `repmat` | `length(n)` | `> 2` | > 2D matrix | 2D matrix | | `repmat` | `length(n)` | `> 2` | > 2D matrix | 2D matrix |
As general remarks, one should keep in mind that: ## Functional differences in base Matlab functions
- For compliance with IEC 60559, the `round` in base R rounds .5 to the nearest even integer, whereas the homonym function in Matlab rounds up (or down, if negative). Function | Matlab output | R output
- Some clobal variables have been added as a new (last) argument to the function they appear in. -------- | ------------- | --------
`max` | Can handle complex numbers | Cannot handle complex numbers