-
All Classes and Interfaces Interfaces Classes
+
All Classes and Interfaces Classes Enum Classes
@@ -96,10 +96,14 @@
Package math.wfc.rules
A rule that forces a certain amount of a tile to be in each row of a grid.
-
-
+
+
A Interface for functions on a rule.
+
+
+
Enum used to output the State of the Rule.
+
diff --git a/docs/math/wfc/rules/package-tree.html b/docs/math/wfc/rules/package-tree.html
index 7fa1a06..d493ac0 100644
--- a/docs/math/wfc/rules/package-tree.html
+++ b/docs/math/wfc/rules/package-tree.html
@@ -1,11 +1,11 @@
-
+
math.wfc.rules Class Hierarchy
-
+
@@ -59,17 +59,29 @@
Class Hierarchy
-Interface Hierarchy
+Enum Class Hierarchy
+
diff --git a/docs/member-search-index.js b/docs/member-search-index.js
index a529323..ba05179 100644
--- a/docs/member-search-index.js
+++ b/docs/member-search-index.js
@@ -1 +1 @@
-memberSearchIndex = [{"p":"math.wfc","c":"Gridstate","l":"clone()"},{"p":"math.wfc","c":"Superposition","l":"clone()"},{"p":"math.wfc","c":"Gridstate","l":"collapse()"},{"p":"math.wfc","c":"Superposition","l":"collapsePossibilities(Gridstate)","u":"collapsePossibilities(math.wfc.Gridstate)"},{"p":"math.wfc","c":"Superposition","l":"collapseTo(int)"},{"p":"math.wfc","c":"Superposition","l":"collapseToFromPossible(int)"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"FixedAmountPerBlock(int, int, int)","u":"%3Cinit%3E(int,int,int)"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"FixedAmountPerColumn(int)","u":"%3Cinit%3E(int)"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"FixedAmountPerRow(int)","u":"%3Cinit%3E(int)"},{"p":"math.wfc","c":"WFC_Handler","l":"getGrid()"},{"p":"math.wfc","c":"Gridstate","l":"getHeight()"},{"p":"math.wfc","c":"Tile","l":"getId()"},{"p":"math.wfc","c":"Gridstate","l":"getPosition(int, int)","u":"getPosition(int,int)"},{"p":"math.wfc","c":"Superposition","l":"getPossibilityCount()"},{"p":"math.wfc","c":"Superposition","l":"getTile()"},{"p":"math.wfc","c":"Gridstate","l":"getWidth()"},{"p":"math.wfc","c":"Gridstate","l":"Gridstate(int, int, Tile[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[])"},{"p":"math.wfc","c":"Gridstate","l":"Gridstate(Superposition[][], boolean, Superposition)","u":"%3Cinit%3E(math.wfc.Superposition[][],boolean,math.wfc.Superposition)"},{"p":"math.wfc","c":"Superposition","l":"isCollapsed()"},{"p":"math.wfc","c":"Gridstate","l":"isFinished()"},{"p":"math.wfc","c":"Tile","l":"isForced(Gridstate, int, int)","u":"isForced(math.wfc.Gridstate,int,int)"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"isForced(Gridstate, int, int, Tile)","u":"isForced(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"isForced(Gridstate, int, int, Tile)","u":"isForced(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"isForced(Gridstate, int, int, Tile)","u":"isForced(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"Rule","l":"isForced(Gridstate, int, int, Tile)","u":"isForced(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc","c":"Tile","l":"isPossible(Gridstate, int, int)","u":"isPossible(math.wfc.Gridstate,int,int)"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"isPossible(Gridstate, int, int, Tile)","u":"isPossible(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"isPossible(Gridstate, int, int, Tile)","u":"isPossible(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"isPossible(Gridstate, int, int, Tile)","u":"isPossible(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"Rule","l":"isPossible(Gridstate, int, int, Tile)","u":"isPossible(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.testing","c":"Sudoku","l":"main(String[])","u":"main(java.lang.String[])"},{"p":"math.wfc","c":"Gridstate","l":"makeRandomChoice(Random)","u":"makeRandomChoice(java.util.Random)"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"mirrorX()"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"mirrorX()"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"mirrorX()"},{"p":"math.wfc.rules","c":"Rule","l":"mirrorX()"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"mirrorY()"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"mirrorY()"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"mirrorY()"},{"p":"math.wfc.rules","c":"Rule","l":"mirrorY()"},{"p":"math.wfc","c":"WFC_Handler","l":"printGrid()"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"rotate()"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"rotate()"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"rotate()"},{"p":"math.wfc.rules","c":"Rule","l":"rotate()"},{"p":"math.testing","c":"Sudoku","l":"Sudoku()","u":"%3Cinit%3E()"},{"p":"math.wfc","c":"Superposition","l":"Superposition(int, int, Tile[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[])"},{"p":"math.wfc","c":"Superposition","l":"Superposition(int, int, Tile[], boolean[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[],boolean[])"},{"p":"math.wfc","c":"Tile","l":"Tile(int)","u":"%3Cinit%3E(int)"},{"p":"math.wfc","c":"Tile","l":"Tile(int, Rule[])","u":"%3Cinit%3E(int,math.wfc.rules.Rule[])"},{"p":"math.wfc","c":"Superposition","l":"tilePossible(Tile)","u":"tilePossible(math.wfc.Tile)"},{"p":"math.wfc","c":"Gridstate","l":"toString()"},{"p":"math.wfc","c":"WFC_Handler","l":"WFC_Handler(Gridstate)","u":"%3Cinit%3E(math.wfc.Gridstate)"},{"p":"math.wfc","c":"WFC_Handler","l":"WFC_Handler(int, int, Tile[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[])"},{"p":"math.wfc","c":"WFC_Handler","l":"wfc()"}];updateSearchResults();
\ No newline at end of file
+memberSearchIndex = [{"p":"math.wfc","c":"Gridstate","l":"clone()"},{"p":"math.wfc","c":"Superposition","l":"clone()"},{"p":"math.wfc","c":"Gridstate","l":"collapse()"},{"p":"math.wfc","c":"Superposition","l":"collapsePossibilities(Gridstate)","u":"collapsePossibilities(math.wfc.Gridstate)"},{"p":"math.wfc","c":"Superposition","l":"collapseTo(int)"},{"p":"math.wfc","c":"Superposition","l":"collapseToFromPossible(int)"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"FixedAmountPerBlock(int, int, int)","u":"%3Cinit%3E(int,int,int)"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"FixedAmountPerColumn(int)","u":"%3Cinit%3E(int)"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"FixedAmountPerRow(int)","u":"%3Cinit%3E(int)"},{"p":"math.wfc.rules","c":"Rule.STATE","l":"FORBIDDEN"},{"p":"math.wfc.rules","c":"Rule.STATE","l":"FORCED"},{"p":"math.wfc","c":"WFC_Handler","l":"getGrid()"},{"p":"math.wfc","c":"Gridstate","l":"getHeight()"},{"p":"math.wfc","c":"Tile","l":"getId()"},{"p":"math.wfc","c":"Gridstate","l":"getPosition(int, int)","u":"getPosition(int,int)"},{"p":"math.wfc","c":"Superposition","l":"getPossibilityCount()"},{"p":"math.wfc","c":"Tile","l":"getState(Gridstate, int, int)","u":"getState(math.wfc.Gridstate,int,int)"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"getState(Gridstate, int, int, Tile)","u":"getState(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"getState(Gridstate, int, int, Tile)","u":"getState(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"getState(Gridstate, int, int, Tile)","u":"getState(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc.rules","c":"Rule","l":"getState(Gridstate, int, int, Tile)","u":"getState(math.wfc.Gridstate,int,int,math.wfc.Tile)"},{"p":"math.wfc","c":"Superposition","l":"getTile()"},{"p":"math.wfc","c":"Gridstate","l":"getWidth()"},{"p":"math.wfc","c":"Gridstate","l":"Gridstate(int, int, Tile[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[])"},{"p":"math.wfc","c":"Gridstate","l":"Gridstate(Superposition[][], boolean, Superposition)","u":"%3Cinit%3E(math.wfc.Superposition[][],boolean,math.wfc.Superposition)"},{"p":"math.wfc.rules","c":"Rule.STATE","l":"IMPOSSIBLE"},{"p":"math.wfc","c":"Superposition","l":"isCollapsed()"},{"p":"math.wfc","c":"Gridstate","l":"isFinished()"},{"p":"math.testing","c":"Sudoku","l":"main(String[])","u":"main(java.lang.String[])"},{"p":"math.wfc","c":"Gridstate","l":"makeRandomChoice(Random)","u":"makeRandomChoice(java.util.Random)"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"mirrorX()"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"mirrorX()"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"mirrorX()"},{"p":"math.wfc.rules","c":"Rule","l":"mirrorX()"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"mirrorY()"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"mirrorY()"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"mirrorY()"},{"p":"math.wfc.rules","c":"Rule","l":"mirrorY()"},{"p":"math.wfc.rules","c":"Rule.STATE","l":"POSSIBLE"},{"p":"math.wfc","c":"WFC_Handler","l":"printGrid()"},{"p":"math.wfc.rules","c":"FixedAmountPerBlock","l":"rotate()"},{"p":"math.wfc.rules","c":"FixedAmountPerColumn","l":"rotate()"},{"p":"math.wfc.rules","c":"FixedAmountPerRow","l":"rotate()"},{"p":"math.wfc.rules","c":"Rule","l":"rotate()"},{"p":"math.wfc.rules","c":"Rule","l":"Rule()","u":"%3Cinit%3E()"},{"p":"math.testing","c":"Sudoku","l":"Sudoku()","u":"%3Cinit%3E()"},{"p":"math.wfc","c":"Superposition","l":"Superposition(int, int, Tile[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[])"},{"p":"math.wfc","c":"Superposition","l":"Superposition(int, int, Tile[], boolean[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[],boolean[])"},{"p":"math.wfc","c":"Tile","l":"Tile(int)","u":"%3Cinit%3E(int)"},{"p":"math.wfc","c":"Tile","l":"Tile(int, Rule[])","u":"%3Cinit%3E(int,math.wfc.rules.Rule[])"},{"p":"math.wfc","c":"Superposition","l":"tilePossible(Tile)","u":"tilePossible(math.wfc.Tile)"},{"p":"math.wfc","c":"Gridstate","l":"toString()"},{"p":"math.wfc.rules","c":"Rule.STATE","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"math.wfc.rules","c":"Rule.STATE","l":"values()"},{"p":"math.wfc","c":"WFC_Handler","l":"WFC_Handler(Gridstate)","u":"%3Cinit%3E(math.wfc.Gridstate)"},{"p":"math.wfc","c":"WFC_Handler","l":"WFC_Handler(int, int, Tile[])","u":"%3Cinit%3E(int,int,math.wfc.Tile[])"},{"p":"math.wfc","c":"WFC_Handler","l":"wfc()"}];updateSearchResults();
\ No newline at end of file
diff --git a/docs/overview-summary.html b/docs/overview-summary.html
index e51457b..033ca4e 100644
--- a/docs/overview-summary.html
+++ b/docs/overview-summary.html
@@ -1,11 +1,11 @@
-
+
Generated Documentation (Untitled)
-
+
diff --git a/docs/overview-tree.html b/docs/overview-tree.html
index 043ac38..55f68ec 100644
--- a/docs/overview-tree.html
+++ b/docs/overview-tree.html
@@ -1,11 +1,11 @@
-
+
Class Hierarchy
-
+
@@ -61,10 +61,14 @@
Class Hierarchy
java.lang.Object
-Interface Hierarchy
+Enum Class Hierarchy
+
diff --git a/docs/type-search-index.js b/docs/type-search-index.js
index d508eb9..aef69aa 100644
--- a/docs/type-search-index.js
+++ b/docs/type-search-index.js
@@ -1 +1 @@
-typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"math.wfc.rules","l":"FixedAmountPerBlock"},{"p":"math.wfc.rules","l":"FixedAmountPerColumn"},{"p":"math.wfc.rules","l":"FixedAmountPerRow"},{"p":"math.wfc","l":"Gridstate"},{"p":"math.wfc.rules","l":"Rule"},{"p":"math.testing","l":"Sudoku"},{"p":"math.wfc","l":"Superposition"},{"p":"math.wfc","l":"Tile"},{"p":"math.wfc","l":"WFC_Handler"}];updateSearchResults();
\ No newline at end of file
+typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"math.wfc.rules","l":"FixedAmountPerBlock"},{"p":"math.wfc.rules","l":"FixedAmountPerColumn"},{"p":"math.wfc.rules","l":"FixedAmountPerRow"},{"p":"math.wfc","l":"Gridstate"},{"p":"math.wfc.rules","l":"Rule"},{"p":"math.wfc.rules","l":"Rule.STATE"},{"p":"math.testing","l":"Sudoku"},{"p":"math.wfc","l":"Superposition"},{"p":"math.wfc","l":"Tile"},{"p":"math.wfc","l":"WFC_Handler"}];updateSearchResults();
\ No newline at end of file
diff --git a/src/math/wfc/rules/Rule.java b/src/math/wfc/rules/Rule.java
index 9aac41a..300cda6 100644
--- a/src/math/wfc/rules/Rule.java
+++ b/src/math/wfc/rules/Rule.java
@@ -40,15 +40,23 @@ public Rule mirrorY(){
/**
* Enum used to output the State of the Rule.
- * FORCED: When this is returned the Tile will instantly be placed at that position
- * POSSIBLE: When this is returned the Tile can be at this position. (Should be the default)
- * IMPOSSBILE: The Tile can't be at this position anymore. The rule won't be executed at that position again.
- * FORBIDDEN: The Grid can't be filled anymore.
*/
public enum STATE {
+ /**
+ * When this is returned the Tile will instantly be placed at that position
+ */
FORCED,
+ /**
+ * When this is returned the Tile can be at this position. (Should be the default)
+ */
POSSIBLE,
+ /**
+ * The Tile can't be at this position anymore. The rule won't be executed at that position again
+ */
IMPOSSIBLE,
+ /**
+ * The Grid can't be filled anymore
+ */
FORBIDDEN;
}
}
\ No newline at end of file