Difference between pages "r7.1.1:Macro LFDS711 PRNG ST MIXING FUNCTION" and "r7.1.1:Macro LFDS711 QUEUE BMM GET USER STATE FROM STATE"

From liblfds.org
(Difference between pages)
Jump to navigation Jump to search
m (1 revision imported)
 
m (1 revision imported)
 
Line 1: Line 1:
{{DISPLAYTITLE:macro LFDS711_PRNG_ST_MIXING_FUNCTION}}
{{DISPLAYTITLE:macro LFDS711_QUEUE_BMM_GET_USER_STATE_FROM_STATE}}
==Source Files==
==Source File==
  └───liblfds711
  └───liblfds711
     └───inc
     └───inc
         └───liblfds711
         └───liblfds711
                 lfds711_prng.h
                 lfds711_queue_bmm.h
 
==Opaque Structures==
struct [[r7.1.1:struct lfds711_prng_st_state|lfds711_prng_st_state]];


==Macro==
==Macro==
  #define LFDS711_PRNG_MIXING_FUNCTION( random_value )
  #define LFDS711_QUEUE_BMM_GET_USER_STATE_FROM_STATE( queue_bmm_state )


==Parameters==
==Parameters==
''random_value''.
''queue_bmm_state''
: A ''lfds711_pal_uint_t''.  Not a pointer to it - the varible itself.  It will be set by the macro.
: An initialized ''struct lfds711_queue_bmm_state''.  Not a pointer to it - the struct itself.


==Return Value==
==Return Value==
No return value.
Returns a ''void *'', the ''user_state'' argument from ''[[r7.1.1:function lfds711_queue_bmm_init_valid_on_current_logical_core|lfds711_bmm_queue_init_valid_on_current_logical_core]]''.


==Notes==
==Notes==
This macro runs a mixing function on the ''random_value'' argument, randomizing its bits.
The user state value can only be set the once, when the data structure instance is initialized.
 
As with all ''liblfds'' macros, the macro operates on the structure itself, not a pointer to it.


The macro is single-threaded.
==Example==
Coming soon!  (no, really!)


==See Also==
==See Also==
* [[r7.1.1:PRNG|PRNG]]
* [[r7.1.1:Queue (bounded, many producer, many consumer)|Queue (bounded, many producer, many consumer)]]

Latest revision as of 18:12, 16 February 2017

Source File

└───liblfds711
    └───inc
        └───liblfds711
                lfds711_queue_bmm.h

Macro

#define LFDS711_QUEUE_BMM_GET_USER_STATE_FROM_STATE( queue_bmm_state )

Parameters

queue_bmm_state

An initialized struct lfds711_queue_bmm_state. Not a pointer to it - the struct itself.

Return Value

Returns a void *, the user_state argument from lfds711_bmm_queue_init_valid_on_current_logical_core.

Notes

The user state value can only be set the once, when the data structure instance is initialized.

As with all liblfds macros, the macro operates on the structure itself, not a pointer to it.

Example

Coming soon! (no, really!)

See Also

Retrieved from ‘https://www.liblfds.org/mediawiki/index.php?title=r7.1.1:Macro_LFDS711_PRNG_ST_MIXING_FUNCTION&oldid=1079’