@stdlib/os-float-word-order

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Float word Order

Platform float word order.

Installation

npm install @stdlib/os-float-word-order

Usage

var FLOAT_WORD_ORDER = require( '@stdlib/os-float-word-order' );

FLOAT_WORD_ORDER

Platform float word order.

console.log( FLOAT_WORD_ORDER );
// => <string>

Notes

• The following values are possible:

  • 'little-endian'
  • 'big-endian'
  • 'unknown'

Examples

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

#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.

#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

#include "stdlib/os/float_word_order.h"
#include "stdlib/os/byte_order.h"
#include <stdio.h>

int main( void ) {
#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
}

See Also

• @stdlib/os-float-word-order-cli: CLI package for use as a command-line utility.
• @stdlib/os-byte-order: platform byte order.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

Changelog

0.1.1 (2023-10-09)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.1.0">