Class TilePropagator

TilePropagator is the main entrypoint to the DeBroglie library. It takes a TileModel and an output Topology and generates an output array using those parameters.

Inheritance

Object

TilePropagator

Namespace: DeBroglie

Assembly: DeBroglie.dll

Syntax

public class TilePropagator

Constructors

TilePropagator(TileModel, ITopology, TilePropagatorOptions)

Declaration

public TilePropagator(TileModel tileModel, ITopology topology, TilePropagatorOptions options)

Parameters

Type	Name	Description
TileModel	tileModel
ITopology	topology
TilePropagatorOptions	options

TilePropagator(TileModel, ITopology, Boolean, ITileConstraint[])

Constructs a TilePropagator.

Declaration

public TilePropagator(TileModel tileModel, ITopology topology, bool backtrack = false, ITileConstraint[] constraints = null)

Parameters

Type	Name	Description
TileModel	tileModel	The model to guide the generation.
ITopology	topology	The dimensions of the output to generate
Boolean	backtrack	If true, store additional information to allow rolling back choices that lead to a contradiction.
ITileConstraint[]	constraints	Extra constraints to control the generation process.

TilePropagator(TileModel, ITopology, Boolean, ITileConstraint[], Random)

Constructs a TilePropagator.

Declaration

[Obsolete("Use TilePropagatorOptions")]
public TilePropagator(TileModel tileModel, ITopology topology, bool backtrack, ITileConstraint[] constraints, Random random)

Parameters

Type	Name	Description
TileModel	tileModel	The model to guide the generation.
ITopology	topology	The dimensions of the output to generate
Boolean	backtrack	If true, store additional information to allow rolling back choices that lead to a contradiction.
ITileConstraint[]	constraints	Extra constraints to control the generation process.
Random	random	Source of randomness

Properties

BacktrackCount

This is incremented each time it is necessary to backtrack a tile while generating results. It is reset when Clear() is called.

Declaration

public int BacktrackCount { get; }

Property Value

Type	Description
Int32

RandomDouble

The source of randomness

Declaration

public Func<double> RandomDouble { get; }

Property Value

Type	Description
Func<Double>

Status

The overall resolution of the generated array. This will be Contradiction if at least one location is in contradiction (has no possible tiles) otherwilse will be Undecided if at least one location is undecided (has multiple possible tiles) and will be Decided otherwise (exactly one tile valid for each location).

Declaration

public Resolution Status { get; }

Property Value

Type	Description
Resolution

TileModel

The model to use when generating.

Declaration

public TileModel TileModel { get; }

Property Value

Type	Description
TileModel

Topology

The topology of the output.

Declaration

public ITopology Topology { get; }

Property Value

Type	Description
ITopology

Methods

Ban(Int32, Int32, Int32, Tile)

Marks the given tile as not being a valid choice at a given location. Then it propagates that information to other nearby tiles.

Declaration

public Resolution Ban(int x, int y, int z, Tile tile)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
Tile	tile

Returns

Type	Description
Resolution	The current Status

Ban(Int32, Int32, Int32, TilePropagatorTileSet)

Marks the given tiles as not being a valid choice at a given location. Then it propagates that information to other nearby tiles.

Declaration

public Resolution Ban(int x, int y, int z, TilePropagatorTileSet tiles)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
TilePropagatorTileSet	tiles

Returns

Type	Description
Resolution	The current Status

Ban(Int32, Int32, Int32, IEnumerable<Tile>)

Marks the given tiles as not being a valid choice at a given location. Then it propagates that information to other nearby tiles.

Declaration

public Resolution Ban(int x, int y, int z, IEnumerable<Tile> tiles)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
IEnumerable<Tile>	tiles

Returns

Type	Description
Resolution	The current Status

Clear()

Resets the TilePropagator to the state it was in at construction.

Declaration

public Resolution Clear()

Returns

Type	Description
Resolution	The current Status (usually Undecided unless there are very specific initial conditions)

CreateTileSet(IEnumerable<Tile>)

Creates a set of tiles. This set can be used with some operations, and is marginally faster than passing in a fresh list of tiles ever time.

Declaration

public TilePropagatorTileSet CreateTileSet(IEnumerable<Tile> tiles)

Parameters

Type	Name	Description
IEnumerable<Tile>	tiles

Returns

Type	Description
TilePropagatorTileSet

GetBannedSelected(Int32, Int32, Int32, Tile, out Boolean, out Boolean)

Gets the results of both IsBanned and IsSelected

Declaration

public void GetBannedSelected(int x, int y, int z, Tile tile, out bool isBanned, out bool isSelected)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
Tile	tile
Boolean	isBanned
Boolean	isSelected

GetBannedSelected(Int32, Int32, Int32, TilePropagatorTileSet, out Boolean, out Boolean)

isBanned is set to true if all the tiles are not valid in the location. isSelected is set to true if no other the tiles are valid in the location.

Declaration

public void GetBannedSelected(int x, int y, int z, TilePropagatorTileSet tiles, out bool isBanned, out bool isSelected)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
TilePropagatorTileSet	tiles
Boolean	isBanned
Boolean	isSelected

GetBannedSelected(Int32, Int32, Int32, IEnumerable<Tile>, out Boolean, out Boolean)

isBanned is set to true if all the tiles are not valid in the location. isSelected is set to true if no other the tiles are valid in the location.

Declaration

public void GetBannedSelected(int x, int y, int z, IEnumerable<Tile> tiles, out bool isBanned, out bool isSelected)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
IEnumerable<Tile>	tiles
Boolean	isBanned
Boolean	isSelected

GetProgress()

Returns a number between 0 and 1 indicating how much of the generation is complete. This number may decrease at times due to backtracking.

Declaration

public double GetProgress()

Returns

Type	Description
Double

IsBanned(Int32, Int32, Int32, Tile)

Returns true if this tile is the not a valid selection for a given location.

Declaration

public bool IsBanned(int x, int y, int z, Tile tile)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
Tile	tile

Returns

Type	Description
Boolean

IsSelected(Int32, Int32, Int32, Tile)

Returns true if this tile is the only valid selection for a given location.

Declaration

public bool IsSelected(int x, int y, int z, Tile tile)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
Tile	tile

Returns

Type	Description
Boolean

Run()

Repeatedly Steps until the status is Decided or Contradiction.

Declaration

public Resolution Run()

Returns

Type	Description
Resolution	The current Status

Select(Int32, Int32, Int32, Tile)

Marks the given tile as the only valid choice at a given location. This is equivalent to banning all other tiles. Then it propagates that information to other nearby tiles.

Declaration

public Resolution Select(int x, int y, int z, Tile tile)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
Tile	tile

Returns

Type	Description
Resolution	The current Status

Select(Int32, Int32, Int32, TilePropagatorTileSet)

Marks the given tiles as the only valid choice at a given location. This is equivalent to banning all other tiles. Then it propagates that information to other nearby tiles.

Declaration

public Resolution Select(int x, int y, int z, TilePropagatorTileSet tiles)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
TilePropagatorTileSet	tiles

Returns

Type	Description
Resolution	The current Status

Select(Int32, Int32, Int32, IEnumerable<Tile>)

Marks the given tiles as the only valid choice at a given location. This is equivalent to banning all other tiles. Then it propagates that information to other nearby tiles.

Declaration

public Resolution Select(int x, int y, int z, IEnumerable<Tile> tiles)

Parameters

Type	Name	Description
Int32	x
Int32	y
Int32	z
IEnumerable<Tile>	tiles

Returns

Type	Description
Resolution	The current Status

SetContradiction()

Indicates that the generation cannot proceed, forcing the algorithm to backtrack or exit.

Declaration

public void SetContradiction()

Step()

Makes a single tile selection. Then it propagates that information to other nearby tiles. If backtracking is enabled a single step can include several backtracks,.

Declaration

public Resolution Step()

Returns

Type	Description
Resolution	The current Status

ToArray(Tile, Tile)

Converts the generated results to an ITopoArray<T>, using specific tiles for locations that have not been decided or are in contradiction. The arguments are not relevant if the Status is Decided.

Declaration

public ITopoArray<Tile> ToArray(Tile undecided = default(Tile), Tile contradiction = default(Tile))

Parameters

Type	Name	Description
Tile	undecided
Tile	contradiction

Returns

Type	Description
ITopoArray<Tile>

ToArraySets()

Convert the generated result to an array of sets, where each set indicates the tiles that are still valid at the location. The size of the set indicates the resolution of that location:

• Greater than 1: Undecided
• Exactly 1: Decided
• Exactly 0: Contradiction

Declaration

public ITopoArray<ISet<Tile>> ToArraySets()

Returns

Type	Description
ITopoArray<ISet<Tile>>

ToValueArray<T>(T, T)

Converts the generated results to an ITopoArray<T>, by extracting the value of each decided tile and using specific values for locations that have not been decided or are in contradiction. This is simply a convenience over The arguments are not relevant if the Status is Decided.

Declaration

public ITopoArray<T> ToValueArray<T>(T undecided = null, T contradiction = null)

Parameters

Type	Name	Description
T	undecided
T	contradiction

Returns

Type	Description
ITopoArray<T>

Type Parameters

Name	Description
T

ToValueSets<T>()

Convert the generated result to an array of sets, where each set indicates the values of tiles that are still valid at the location. The size of the set indicates the resolution of that location:

• Greater than 1: Undecided
• Exactly 1: Decided
• Exactly 0: Contradiction

Declaration

public ITopoArray<ISet<T>> ToValueSets<T>()

Returns

Type	Description
ITopoArray<ISet<T>>

Type Parameters

Name	Description
T