<!--
This file is generated by a tool. Do not edit directly.
For open-source contributions the docs will be updated automatically.
-->

*Last updated: 2023-03-16.*

<div itemscope itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="tf_quant_finance.math.qmc.random_scrambling_matrices" />
<meta itemprop="path" content="Stable" />
</div>

# tf_quant_finance.math.qmc.random_scrambling_matrices

<!-- Insert buttons and diff -->

<table class="tfo-notebook-buttons tfo-api" align="left">
</table>

<a target="_blank" href="https://github.com/paolodelia99/tf-quant-finance/blob/main/tf_quant_finance/math/qmc/digital_net.py">View source</a>



Returns a `Tensor` drawn from a uniform distribution.

```python
tf_quant_finance.math.qmc.random_scrambling_matrices(
    dim, num_digits, seed, validate_args=False, dtype=None, name=None
)
```



<!-- Placeholder for "Used in" -->

The result can be can be passed to the `scramble_generating_matrices` function
to randomize a given `generating_matrices`.

#### Examples

```python
import tf_quant_finance as tff

# Example: Creating random matrices which can scramble 2D generating matrices.

dim = 2
num_digits = 10
seed = (2, 3)

tff.math.qmc.random_scrambling_matrices(dim, num_digits, seed=seed)
# ==> tf.Tensor([
#             [586, 1011, 896,  818, 550, 1009, 880, 855,  686, 758],
#             [872,  958, 870, 1000, 963,  919, 994, 583, 1007, 739],
#         ], shape=(2, 10), dtype=int32)
```

#### Args:


* <b>`dim`</b>: Positive scalar `Tensor` of integers with rank 0. The event size of
  points which can be sampled from the generating matrices to scramble.
* <b>`num_digits`</b>: Positive scalar `Tensor` of integers with rank 0. the base-2
  precision of the points which can be sampled from the generating matrices
  to scramble.
* <b>`seed`</b>: Positive scalar `Tensor` with shape [2] and dtype `int32` used as seed
  for the random generator.
* <b>`validate_args`</b>: Python `bool` indicating whether to validate arguments.
  Default value: `False`.
* <b>`dtype`</b>: Optional `dtype`. The `dtype` of the output `Tensor` (either
  `tf.int32` or `tf.int64`).
  Default value: `None` which maps to `tf.int32`.
* <b>`name`</b>: Python `str` name prefixed to ops created by this function.
  Default value: `None` which maps to `random_scrambling_matrices`.


#### Returns:

A `Tensor` with `shape` `(dim, num_digits)`.
