*Last updated: 2023-03-16.*
# tf_quant_finance.datetime.PeriodTensor
View source
Represents a tensor of time periods.
```python
tf_quant_finance.datetime.PeriodTensor(
quantity, period_type
)
```
#### Args:
* `quantity`: A Tensor of type tf.int32, representing the quantities
of period types (e.g. how many months). Can be both positive and
negative.
* `period_type`: A PeriodType (a day, a month, etc). Currently only one
PeriodType per instance of PeriodTensor is supported.
#### Attributes:
* `rank`
* `shape`
## Methods
__add__
View source
```python
__add__(
other
)
```
Adds another PeriodTensor of the same type.
__getitem__
View source
```python
__getitem__(
key
)
```
Implements indexing.
__mul__
View source
```python
__mul__(
multiplier
)
```
Multiplies PeriodTensor by a Tensor of ints.
__sub__
View source
```python
__sub__(
other
)
```
Subtracts another PeriodTensor of the same type.
boolean_mask
View source
```python
boolean_mask(
mask, axis=None
)
```
See tf.boolean_mask.
broadcast_to
View source
```python
broadcast_to(
shape
)
```
See tf.broadcast_to.
concat
View source
```python
@classmethod
concat(
cls, tensor_wrappers, axis
)
```
See tf.concat.
expand_dims
View source
```python
expand_dims(
axis
)
```
See tf.expand_dims.
identity
View source
```python
identity()
```
See tf.identity.
period_type
View source
```python
period_type()
```
Returns the PeriodType of this PeriodTensor.
quantity
View source
```python
quantity()
```
Returns the quantities tensor of this PeriodTensor.
reshape
View source
```python
reshape(
shape
)
```
See tf.reshape.
squeeze
View source
```python
squeeze(
axis=None
)
```
See tf.squeeze.
stack
View source
```python
@classmethod
stack(
cls, tensor_wrappers, axis=0
)
```
See tf.stack.
transpose
View source
```python
transpose(
perm=None
)
```
See tf.transpose.
where
View source
```python
@classmethod
where(
cls, condition, tensor_wrapper_1, tensor_wrapper_2
)
```
See tf.where. Only three-argument version is supported here.