# Float word Order
> Platform [float word order][endianness].
## Usage
```javascript
var FLOAT_WORD_ORDER = require( '@stdlib/os/float-word-order' );
```
#### FLOAT_WORD_ORDER
Platform float word order.
```javascript
console.log( FLOAT_WORD_ORDER );
// =>
```
## Notes
- The following values are possible:
- `'little-endian'`
- `'big-endian'`
- `'unknown'`
## Examples
```javascript
var FLOAT_WORD_ORDER = require( '@stdlib/os/float-word-order' );
if ( FLOAT_WORD_ORDER === 'little-endian' ) {
console.log( 'Least significant word comes first...' );
} else if ( FLOAT_WORD_ORDER === 'big-endian' ) {
console.log( 'Most significant word comes first...' );
} else {
console.log( 'This is uncommon...' );
}
```
* * *
## C APIs
### Usage
```c
#include "stdlib/os/float_word_order.h"
```
#### STDLIB_OS_FLOAT_WORD_ORDER
Macro which equals either `__FLOAT_WORD_ORDER__` (host defined) or [`STDLIB_OS_BYTE_ORDER`][@stdlib/os/byte-order].
```c
#include "stdlib/os/byte_order.h"
#if defined(STDLIB_OS_FLOAT_WORD_ORDER)
#if STDLIB_OS_FLOAT_WORD_ORDER == STDLIB_OS_ORDER_LITTLE_ENDIAN
// Do something for little-endian...
#elif STDLIB_OS_FLOAT_WORD_ORDER == STDLIB_OS_ORDER_BIG_ENDIAN
// Do something for big-endian...
#endif
#endif
```
If compiled on an unrecognized/unsupported platform, the macro is **not** defined.
### Examples
```c
#include "stdlib/os/float_word_order.h"
#include "stdlib/os/byte_order.h"
#include
int main() {
#if defined(STDLIB_OS_FLOAT_WORD_ORDER)
#if STDLIB_OS_FLOAT_WORD_ORDER == STDLIB_OS_ORDER_LITTLE_ENDIAN
printf( "Least significant word comes first...\n" );
#elif STDLIB_OS_FLOAT_WORD_ORDER == STDLIB_OS_ORDER_BIG_ENDIAN
printf( "Most significant word comes first...\n" );
#else
printf( "Platform float word order is unknown...\n" )
#endif
#endif
}
```
* * *
## CLI
### Usage
```text
Usage: float-word-order [options]
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
### Examples
```bash
$ float-word-order
```
[endianness]: https://en.wikipedia.org/wiki/Endianness
[@stdlib/os/byte-order]: https://www.npmjs.com/package/@stdlib/os/tree/main/byte-order