partition_rectanglepartition_rectanglePartitionRectanglePartitionRectanglepartition_rectangle (Operator)

Name

partition_rectanglepartition_rectanglePartitionRectanglePartitionRectanglepartition_rectangle — Partition a region into rectangles of approximately equal size.

Signature

partition_rectangle(Region : Partitioned : Width, Height : )

Description

partition_rectanglepartition_rectanglePartitionRectanglePartitionRectanglepartition_rectangle partitions the input region into rectangles having an extent of WidthWidthWidthwidthwidth times HeightHeightHeightheightheight. The rectangles are returned in PartitionedPartitionedPartitionedpartitionedpartitioned. The region is always split into rectangles of approximately equal size. If this is not possible with the requested rectangle size, then WidthWidthWidthwidthwidth and HeightHeightHeightheightheight are adapted so that the size of the resulting rectangles is approximately equal. If the region is smaller than the given size, its output remains unchanged. A partition is only done if the size of the region is at least 1.5 times the size of the rectangle given by the parameters.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Automatically parallelized on tuple level.

Parameters

RegionRegionRegionregionregion (input_object) region(-array) → object

Region to be partitioned.

PartitionedPartitionedPartitionedpartitionedpartitioned (output_object) region(-array) → object

Partitioned region.

WidthWidthWidthwidthwidth (input_control) extent.x → (real)

Width of the individual rectangles.

HeightHeightHeightheightheight (input_control) extent.y → (real)

Height of the individual rectangles.

Result

partition_rectanglepartition_rectanglePartitionRectanglePartitionRectanglepartition_rectangle returns 2 ( H_MSG_TRUE) if all parameters are correct. The behavior in case of empty input (no regions given) can be set via set_system('no_object_result',<Result>), the behavior in case of an empty input region via set_system('empty_region_result',<Result>), and the behavior in case of an empty result region via set_system('store_empty_region',<'true'/'false'>). If necessary, an exception is raised.