Modules.ComplexSets package

Submodules

Modules.ComplexSets.ComplexSet module

class Modules.ComplexSets.ComplexSet.ComplexSet(iterations: int, coord_range: Modules.ComplexSets.CoordinateRange.CoordinateRange, xy_vals: tuple, name='Generic')

Bases: abc.ABC

Abstract base class for complex sets.

Parameters

  • iterations (int) – The maximum number of iterations for this set generation.

  • coord_range (coordinaterange) ((float, float), (float, float)) – X and Y range values, respectively.

  • xy_vals (tuple) (int, int) – How many intervals to split the x and y axis into.

  • name (str, optional) – Name of the set, usually called by inherited classes.

template

A grid of complex numbers to match the x and y values given across the given XY ranges.

Type

numpy.ndarray

name

The name of the set.

Type

str

data

The current set data during the generation process.

Type

numpy.ndarray

iteration

The current iteration during the generation process.

Type

int

coord_range

The XY range of the set generation.

Type

coordinaterange) ((float, float), (float, float)

max_iterations

The maximum number of iterations for the set generation.

Type

int

mask

Grid of boolean values focusing only on set numbers that haven’t diverged.

Type

numpy.ndarray

property coord_range

The XY ranges of the set generation.

Type

coordinaterange

property data

Data generated by set generation.

Type

numpy.ndarray

generate_set()

Genereates the full complex set up to the maximum number of iterations.

Parameters

  • xVals (int) – The number of intervals to split the real axis into.

  • yVals (int) – The number of intervals to split the imaginary axis into

Returns

The final set data after the generation process.

Return type

data (numpy.ndarray)

generate_template(xVals: int, yVals: int)

Genereates a complex template to use in the set generation.

Parameters

  • xVals (int) – The number of intervals to split the real axis into.

  • yVals (int) – The number of intervals to split the imaginary axis into

Returns

A grid of complex numbers to match the x and y values given across the given XY ranges.

Return type

(numpy.ndarray)

property iteration

Current iteration during set generation.

Type

int

property mask

Mask to determine what values to compute.

Type

numpy.ndarray

property max_iterations

Maximum iterations for set generation.

Type

int

property name

Name of the set.

Type

str

property template

The complex grid template to use for set generation.

Type

numpy.ndarray

exception Modules.ComplexSets.ComplexSet.TemplateNotGenerated

Bases: Exception

Modules.ComplexSets.CoordinateRange module

class Modules.ComplexSets.CoordinateRange.CoordinateRange(minX: float, maxX: float, minY: float, maxY: float)

Bases: object

Sets a strict boundary between x and y values.

Parameters

  • minX (float) – Minimum x value.

  • maxX (float) – Maximum x value.

  • minY (float) – Minimum y value.

  • maxY (float) – Maximum y value.

Raises

InvalidCoordinateBounds – If one or more minimum is greater than the respective maximum value.

property x_range

The minimum and maximum bounds of the x range, respectively.

Type

tuple (float, float)

property y_range

The minimum and maximum bounds of the y range, respectively.

Type

tuple (float, float)

exception Modules.ComplexSets.CoordinateRange.InvalidCoordinateBounds

Bases: Exception

Raised if one or more minimum is greater than the respective maximum value.

Module contents