NAME¶

ea_conditioning - Compute the entropy of a conditioning function

SYNOPSIS¶

ea_conditioning -v [-q] <n_in> <n_out> <nw> <h_in> [-o filename.json] ea_conditioning -n <n_in> <n_out> <nw> <h_in> [h' | -i filename] [-o filename.json]

DESCRIPTION¶

Compute the entropy of a conditioning function.

<n_in>: input number of bits to conditioning function.

<n_out>: output number of bits from conditioning function.

<nw>: narrowest internal width of conditioning function.

<h_in>: input entropy to conditioning function.

<-v|-n>: '-v' for vetted conditioning function, '-n' for non-vetted conditioning function. Vetted conditioning is the default. <h'>: entropy estimate per bit of conditioned sequential dataset (only for '-n' option).

-q: Quiet mode, less output to screen.

-i: Input file name, to run an entropy assessment on a non-vetted conditioned data file and use that value as h'.

This program computes the entropy of the output of a conditioning function 'h_out' (Section 3.1.5). If the conditioning function is vetted, then

h_out = Output_Entropy(n_in, n_out, nw, h_in)

where 'Output_Entropy' is specified in Section 3.1.5.1.2. If the conditioning function is non-vetted then

h_out = min(Output_Entropy(n_in, n_out, nw, h_in), 0.999*n_out, h'*n_out)

as stated in Section 3.1.5.2.

-o: Set Output Type to JSON

Changes the output format to JSON and sets the file location for the output file.

--version: Prints tool version information

COPYRIGHT¶

Disclaimer: NIST-developed software is provided by NIST as a public service. You may use, copy, and distribute copies of the software in any medium, provided that you keep intact this entire notice. You may improve, modify, and create derivative works of the software or any portion of the software, and you may copy and distribute such modifications or works. Modified works should carry a notice stating that you changed the software and should note the date and nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the source of the software.

NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT, OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE.

You are solely responsible for determining the appropriateness of using and distributing the software and you assume all risks associated with its use, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of operation. This software is not intended to be used in any situation where a failure could cause risk of injury or damage to property. The software developed by NIST employees is not subject to copyright protection within the United States.