RotateLeft constructor

RotateLeft(
  1. Logic original,
  2. Logic rotateAmount, {
  3. int? maxAmount,
  4. String name = 'rotate',
  5. bool reserveName = false,
  6. bool reserveDefinitionName = false,
  7. String? definitionName,
})

Constructs a Module to perform rotation to the left.

Conditionally rotates by different amounts based on the value of rotateAmount. The maxAmount is the largest value for which this rotation should support, which could be greater than the width of rotateAmount.

If no maxAmount is provided, it will default to the width of original. The maxAmount will be not be larger than what could be represented by the maximum value of rotateAmount.

Implementation

RotateLeft(Logic original, Logic rotateAmount,
    {super.maxAmount,
    super.name,
    super.reserveName,
    super.reserveDefinitionName,
    String? definitionName})
    : super(
          definitionName: definitionName ?? 'RotateLeft_W${original.width}',
          RotateDirection.left,
          original,
          rotateAmount);