fsharp / fsharp/fsharp-core-docs

Inaccurate/misleading description of max in operators module (wrt. NaN comparison)

Ouverte
#82 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Aucune donnée de langage
Étoiles
37
Forks
20
Merge moyen
6 min
PR mergées (30 j)
1

Description

Not sure if this is an error in documentation or purposeful omission, or perhaps a bug in fsharp.

[Here](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-operators.html#max) `max` is described as

> Maximum based on generic comparison

And [here](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-operators.html#compare) `compare` is described as

> Generic comparison.

However, even though they kind of boil down to the same thing in implementation for most types, they do not specifically for floating point numbers. Moreover, if one defines a max function with `compare`, for example like this:

```fsharp
let max2 x y = if compare x y < 0 then y else x
```

Then `max2` behaves differently than `max` with respect to NaN, e.g.:
```
> max2 1. nan;;
val it: float = 1.0

> max2 nan 1.;;
val it: float = 1.0
```
whereas
```
> max nan 1.;;
val it: float = nan

> max 1. nan;;
val it: float = nan
```

If this discrepancy in behavior is expected, then perhaps it should be documented?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.