├── .classpath
├── .gitattributes
├── .github
    └── ISSUE_TEMPLATE
    │   ├── bug_report.md
    │   └── feature_request.md
├── .project
├── .settings
    ├── org.eclipse.core.resources.prefs
    └── org.eclipse.jdt.core.prefs
├── LICENSE
├── Maze_solver.ucls
├── README.md
├── bin
    ├── .gitignore
    ├── AStarSolver$1.class
    ├── AStarSolver$2.class
    ├── AStarSolver.class
    ├── BFS_Solver.class
    ├── DFS_Solver.class
    ├── Main.class
    ├── Maze.class
    ├── Node.class
    └── Square.class
├── data
    ├── lab.txt
    ├── lab_big.txt
    └── test.txt
└── src
    ├── AStarSolver.java
    ├── BFS_Solver.java
    ├── DFS_Solver.java
    ├── Main.java
    ├── Maze.java
    ├── Node.java
    ├── Solver.java
    └── Square.java


/.classpath:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <classpath>
3 | 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
4 | 	<classpathentry kind="src" path="src"/>
5 | 	<classpathentry kind="output" path="bin"/>
6 | </classpath>
7 | 


--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
 1 | # Auto detect text files and perform LF normalization
 2 | * text=auto
 3 | 
 4 | # Custom for Visual Studio
 5 | *.cs     diff=csharp
 6 | 
 7 | # Standard to msysgit
 8 | *.doc	 diff=astextplain
 9 | *.DOC	 diff=astextplain
10 | *.docx diff=astextplain
11 | *.DOCX diff=astextplain
12 | *.dot  diff=astextplain
13 | *.DOT  diff=astextplain
14 | *.pdf  diff=astextplain
15 | *.PDF	 diff=astextplain
16 | *.rtf	 diff=astextplain
17 | *.RTF	 diff=astextplain
18 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | 
 5 | ---
 6 | 
 7 | **Describe the bug**
 8 | A clear and concise description of what the bug is.
 9 | 
10 | **To Reproduce**
11 | Steps to reproduce the behavior:
12 | 1. Go to '...'
13 | 2. Click on '....'
14 | 3. Scroll down to '....'
15 | 4. See error
16 | 
17 | **Expected behavior**
18 | A clear and concise description of what you expected to happen.
19 | 
20 | **Screenshots**
21 | If applicable, add screenshots to help explain your problem.
22 | 
23 | **Desktop (please complete the following information):**
24 |  - OS: [e.g. iOS]
25 |  - Browser [e.g. chrome, safari]
26 |  - Version [e.g. 22]
27 | 
28 | **Smartphone (please complete the following information):**
29 |  - Device: [e.g. iPhone6]
30 |  - OS: [e.g. iOS8.1]
31 |  - Browser [e.g. stock browser, safari]
32 |  - Version [e.g. 22]
33 | 
34 | **Additional context**
35 | Add any other context about the problem here.
36 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | 
 5 | ---
 6 | 
 7 | **Is your feature request related to a problem? Please describe.**
 8 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 9 | 
10 | **Describe the solution you'd like**
11 | A clear and concise description of what you want to happen.
12 | 
13 | **Describe alternatives you've considered**
14 | A clear and concise description of any alternative solutions or features you've considered.
15 | 
16 | **Additional context**
17 | Add any other context or screenshots about the feature request here.
18 | 


--------------------------------------------------------------------------------
/.project:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <projectDescription>
 3 | 	<name>M4202C-Maze_solver</name>
 4 | 	<comment></comment>
 5 | 	<projects>
 6 | 	</projects>
 7 | 	<buildSpec>
 8 | 		<buildCommand>
 9 | 			<name>org.eclipse.jdt.core.javabuilder</name>
10 | 			<arguments>
11 | 			</arguments>
12 | 		</buildCommand>
13 | 	</buildSpec>
14 | 	<natures>
15 | 		<nature>org.eclipse.jdt.core.javanature</nature>
16 | 	</natures>
17 | </projectDescription>
18 | 


--------------------------------------------------------------------------------
/.settings/org.eclipse.core.resources.prefs:
--------------------------------------------------------------------------------
1 | eclipse.preferences.version=1
2 | encoding//src/Maze.java=UTF-8
3 | 


--------------------------------------------------------------------------------
/.settings/org.eclipse.jdt.core.prefs:
--------------------------------------------------------------------------------
 1 | eclipse.preferences.version=1
 2 | org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
 3 | org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
 4 | org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
 5 | org.eclipse.jdt.core.compiler.compliance=1.8
 6 | org.eclipse.jdt.core.compiler.debug.lineNumber=generate
 7 | org.eclipse.jdt.core.compiler.debug.localVariable=generate
 8 | org.eclipse.jdt.core.compiler.debug.sourceFile=generate
 9 | org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
10 | org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
11 | org.eclipse.jdt.core.compiler.source=1.8
12 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/Maze_solver.ucls:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <class-diagram version="1.2.2" icons="true" always-add-relationships="false" generalizations="true" realizations="true" 
  3 |   associations="true" dependencies="false" nesting-relationships="true" router="FAN">  
  4 |   <class id="1" language="java" name="Maze" project="M4202C-Maze_solver" file="/M4202C-Maze_solver/src/Maze.java" 
  5 |     binary="false" corner="BOTTOM_RIGHT">    
  6 |     <position height="477" width="249" x="821" y="302"/>    
  7 |     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
  8 |       sort-features="false" accessors="true" visibility="true">      
  9 |       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
 10 |       <operations public="true" package="true" protected="true" private="true" static="true"/>    
 11 |     </display>  
 12 |   </class>  
 13 |   <class id="2" language="java" name="Square" project="M4202C-Maze_solver" file="/M4202C-Maze_solver/src/Square.java" 
 14 |     binary="false" corner="BOTTOM_RIGHT">    
 15 |     <position height="621" width="166" x="821" y="819"/>    
 16 |     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
 17 |       sort-features="false" accessors="true" visibility="true">      
 18 |       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
 19 |       <operations public="true" package="true" protected="true" private="true" static="true"/>    
 20 |     </display>  
 21 |   </class>  
 22 |   <class id="3" language="java" name="Node" project="M4202C-Maze_solver" file="/M4202C-Maze_solver/src/Node.java" 
 23 |     binary="false" corner="BOTTOM_RIGHT">    
 24 |     <position height="225" width="146" x="625" y="302"/>    
 25 |     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
 26 |       sort-features="false" accessors="true" visibility="true">      
 27 |       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
 28 |       <operations public="true" package="true" protected="true" private="true" static="true"/>    
 29 |     </display>  
 30 |   </class>  
 31 |   <class id="4" language="java" name="Solver" project="M4202C-Maze_solver" file="/M4202C-Maze_solver/src/Solver.java" 
 32 |     binary="false" corner="BOTTOM_RIGHT">    
 33 |     <position height="225" width="260" x="821" y="37"/>    
 34 |     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
 35 |       sort-features="false" accessors="true" visibility="true">      
 36 |       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
 37 |       <operations public="true" package="true" protected="true" private="true" static="true"/>    
 38 |     </display>  
 39 |   </class>  
 40 |   <class id="5" language="java" name="BFS_Solver" project="M4202C-Maze_solver" 
 41 |     file="/M4202C-Maze_solver/src/BFS_Solver.java" binary="false" corner="BOTTOM_RIGHT">    
 42 |     <position height="153" width="252" x="41" y="302"/>    
 43 |     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
 44 |       sort-features="false" accessors="true" visibility="true">      
 45 |       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
 46 |       <operations public="true" package="true" protected="true" private="true" static="true"/>    
 47 |     </display>  
 48 |   </class>  
 49 |   <class id="6" language="java" name="DFS_Solver" project="M4202C-Maze_solver" 
 50 |     file="/M4202C-Maze_solver/src/DFS_Solver.java" binary="false" corner="BOTTOM_RIGHT">    
 51 |     <position height="153" width="252" x="1131" y="302"/>    
 52 |     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
 53 |       sort-features="false" accessors="true" visibility="true">      
 54 |       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
 55 |       <operations public="true" package="true" protected="true" private="true" static="true"/>    
 56 |     </display>  
 57 |   </class>  
 58 |   <class id="7" language="java" name="AStarSolver" project="M4202C-Maze_solver" 
 59 |     file="/M4202C-Maze_solver/src/AStarSolver.java" binary="false" corner="BOTTOM_RIGHT">    
 60 |     <position height="153" width="252" x="333" y="302"/>    
 61 |     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
 62 |       sort-features="false" accessors="true" visibility="true">      
 63 |       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
 64 |       <operations public="true" package="true" protected="true" private="true" static="true"/>    
 65 |     </display>  
 66 |   </class>  
 67 |   <generalization id="8">    
 68 |     <end type="SOURCE" refId="7"/>    
 69 |     <end type="TARGET" refId="4"/>  
 70 |   </generalization>  
 71 |   <association id="9">    
 72 |     <end type="SOURCE" refId="1" navigable="false">      
 73 |       <attribute id="10" name="currState"/>      
 74 |       <multiplicity id="11" minimum="0" maximum="1"/>    
 75 |     </end>    
 76 |     <end type="TARGET" refId="2" navigable="true"/>    
 77 |     <display labels="true" multiplicity="true"/>  
 78 |   </association>  
 79 |   <association id="12">    
 80 |     <end type="SOURCE" refId="1" navigable="false">      
 81 |       <attribute id="13" name="end"/>      
 82 |       <multiplicity id="14" minimum="0" maximum="1"/>    
 83 |     </end>    
 84 |     <end type="TARGET" refId="2" navigable="true"/>    
 85 |     <display labels="true" multiplicity="true"/>  
 86 |   </association>  
 87 |   <generalization id="15">    
 88 |     <end type="SOURCE" refId="5"/>    
 89 |     <end type="TARGET" refId="4"/>  
 90 |   </generalization>  
 91 |   <generalization id="16">    
 92 |     <end type="SOURCE" refId="6"/>    
 93 |     <end type="TARGET" refId="4"/>  
 94 |   </generalization>  
 95 |   <association id="17">    
 96 |     <end type="SOURCE" refId="4" navigable="false">      
 97 |       <attribute id="18" name="maze"/>      
 98 |       <multiplicity id="19" minimum="0" maximum="1"/>    
 99 |     </end>    
100 |     <end type="TARGET" refId="1" navigable="true"/>    
101 |     <display labels="true" multiplicity="true"/>  
102 |   </association>  
103 |   <association id="20">    
104 |     <end type="SOURCE" refId="1" navigable="false">      
105 |       <attribute id="21" name="grid"/>      
106 |       <multiplicity id="22" minimum="0" maximum="2147483647"/>    
107 |     </end>    
108 |     <end type="TARGET" refId="2" navigable="true"/>    
109 |     <display labels="true" multiplicity="true"/>  
110 |   </association>  
111 |   <association id="23">    
112 |     <end type="SOURCE" refId="2" navigable="false">      
113 |       <attribute id="24" name="maze"/>      
114 |       <multiplicity id="25" minimum="0" maximum="1"/>    
115 |     </end>    
116 |     <end type="TARGET" refId="1" navigable="true"/>    
117 |     <display labels="true" multiplicity="true"/>  
118 |   </association>  
119 |   <association id="26">    
120 |     <bendpoint x="1100" y="302"/>    
121 |     <bendpoint x="1100" y="786"/>    
122 |     <end type="SOURCE" refId="4" navigable="false">      
123 |       <attribute id="27" name="closedSquares"/>      
124 |       <multiplicity id="28" minimum="0" maximum="2147483647"/>    
125 |     </end>    
126 |     <end type="TARGET" refId="2" navigable="true"/>    
127 |     <display labels="true" multiplicity="true"/>  
128 |   </association>  
129 |   <association id="29">    
130 |     <end type="SOURCE" refId="4" navigable="false">      
131 |       <attribute id="30" name="frontier"/>      
132 |       <multiplicity id="31" minimum="0" maximum="2147483647"/>    
133 |     </end>    
134 |     <end type="TARGET" refId="3" navigable="true"/>    
135 |     <display labels="true" multiplicity="true"/>  
136 |   </association>  
137 |   <association id="32">    
138 |     <end type="SOURCE" refId="1" navigable="false">      
139 |       <attribute id="33" name="start"/>      
140 |       <multiplicity id="34" minimum="0" maximum="1"/>    
141 |     </end>    
142 |     <end type="TARGET" refId="2" navigable="true"/>    
143 |     <display labels="true" multiplicity="true"/>  
144 |   </association>  
145 |   <association id="35">    
146 |     <end type="SOURCE" refId="3" navigable="false">      
147 |       <attribute id="36" name="father"/>      
148 |       <multiplicity id="37" minimum="0" maximum="1"/>    
149 |     </end>    
150 |     <end type="TARGET" refId="3" navigable="true"/>    
151 |     <display labels="true" multiplicity="true"/>  
152 |   </association>  
153 |   <classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
154 |     sort-features="false" accessors="true" visibility="true">    
155 |     <attributes public="true" package="true" protected="true" private="true" static="true"/>    
156 |     <operations public="true" package="true" protected="true" private="true" static="true"/>  
157 |   </classifier-display>  
158 |   <association-display labels="true" multiplicity="true"/>
159 | </class-diagram>


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Java-Maze-Solver
  2 | This program is a console-based maze solving in Java with BFS, DFS, A*.
  3 | 
  4 | 
  5 | 
  6 | 
  7 | Maze structure
  8 | ======
  9 | In this implementation, Mazes consists in a matrix of Squares.
 10 | 
 11 | Here is the orthogonal reprensentation of a Maze:
 12 | ```
 13 | o---> X [Columns]
 14 | |
 15 | v
 16 | Y [Lines]
 17 | ```
 18 | 
 19 | 
 20 | 
 21 | 
 22 | Solve mazes
 23 | ======
 24 | 
 25 | Firstly, see how to [load a maze](#load-a-maze) from a .txt file or [create one](#create-a-maze) directly from code.
 26 | 
 27 | Next, refer to "[Use a solver](#use-a-solver)" to begin solving when your Maze is all set.
 28 | 
 29 | Like any solver, you can also [set your own shift order](#changing-the-shift-order). This program use cardinals as reference and the default one is North-East-South-West.
 30 | 
 31 | 
 32 | 
 33 | 
 34 | Load a maze
 35 | ------
 36 | You can load a maze from a .txt as an argument in Maze class constructor, like this:
 37 | 
 38 | ```Java
 39 | Maze myMaze = new Maze("./path/to/my/maze/myMaze.txt");
 40 | ```
 41 | [Example in Main.java line 25][1]
 42 | 
 43 | The file must be written within this form :
 44 | 
 45 | ```
 46 | -----------------e-
 47 | --xxxxxxxxxxxx-----
 48 | -------------x-----
 49 | ----s--------x-----
 50 | -------------x-----
 51 | -------------------
 52 | -------------------
 53 | ```
 54 | The number of characters in the first line will be the maze number of columns and the number of lines... the number of lines.
 55 | 
 56 | Every character is a square of the maze and is read like this:
 57 | * `s` : maze starting point
 58 | * `e` : maze ending point
 59 | * `x` : wall
 60 | * Other ones (whatever they are) are empty squares.
 61 | 
 62 | 
 63 | 
 64 | 
 65 | 
 66 | Create a maze
 67 | ------
 68 | It's also possible to create a maze directly from code by following those steps, but this is the most laborious method.
 69 | 
 70 | __1. In Main.java, create a starting and a ending square:__
 71 | ```Java
 72 | Square start = new Square(1, 0, "S");
 73 | Square end = new Square(3, 4, "E");
 74 | ```
 75 | Square constructor arguments: `Line (int), Column (int), Identifier (String)`
 76 | 
 77 | `S` stands for starting point and `E` for ending point.
 78 | 
 79 | __2. Create a new Maze:__
 80 | ```Java
 81 | Maze myMaze = new Maze(6, 5, start, end);
 82 | ```
 83 | Maze constructor arguments : `Number of lines (int), Number of columns (int), Starting point (Square), Ending point (Square)`
 84 | 
 85 | __3. Create walls:__
 86 | 
 87 | (If you don't want walls, you can skip this step)
 88 | 
 89 | Use the `setMazeWall()` method:
 90 | ```Java
 91 | myMaze.setMazeWall(2, 0);
 92 | myMaze.setMazeWall(3, 0);
 93 | myMaze.setMazeWall(1, 2);
 94 | myMaze.setMazeWall(2, 2);
 95 | ...
 96 | ```
 97 | Arguments: `Wall line pos (int), Wall column pos (int)`
 98 | 
 99 | 
100 | 
101 | 
102 | 
103 | Use a solver
104 | ------
105 | You have 3 solvers available, each one corresponding to one algorithm:
106 | * AStarSolver
107 | * BFS_Solver
108 | * DFS_Solver
109 | 
110 | Simply use
111 | ```Java
112 | BFS_Solver bfsSolver = new BFS_Solver(myMaze);
113 | DFS_Solver dfsSolver = new DFS_Solver(myMaze);
114 | AStarSolver aStarSolver = new AStarSolver(myMaze, true);
115 | 
116 | System.out.println(bfsSolver.solve());
117 | System.out.println(dfsSolver.solve());
118 | System.out.println(aStarSolver.solve());
119 | ```
120 | 
121 | Note that `AStarSolver` takes one other boolean argument to specifies if you want your maze to be solved by A* with Manhattan or Euclidean heuristic.
122 | 
123 | Set to `true` to use Manhattan heuristic. Euclidean heuristic will be used otherwhise.
124 | 
125 | 
126 | 
127 | 
128 | Changing the shift order
129 | ------
130 | Shift order is defined with a char vertor of size 4, each letter corresponding to a cardinal
131 | 
132 | Here's an example to set the order West-East-North-South
133 | ```Java
134 | char[] order = {'W', 'E', 'N', 'S'};
135 | myMaze.setOrder(order);
136 | ```
137 | 
138 | 
139 | 
140 | 
141 | Example of resolution : A* + Euclidean heuristic
142 | =====
143 | ```
144 | Path: [2, 12](23.0)(End) <- [1, 12](23.0) <- [1, 11](22.414213562373096) <- [1, 10](22.23606797749979) <- [2, 10](21.0) <- [2, 9](21.0) <- [2, 8](21.0) <- [1, 8](20.12310562561766) <- [0, 8](19.47213595499958) <- [0, 7](19.385164807134505) <- [0, 6](19.32455532033676) <- [1, 6](18.08276253029822) <- [2, 6](17.0) <- [3, 6](16.08276253029822) <- [3, 5](16.071067811865476) <- [3, 4](16.06225774829855) <- [4, 4](15.246211251235321) <- [5, 4](14.54400374531753) <- [6, 4](13.94427190999916) <- [6, 3](13.848857801796104) <- [6, 2](13.770329614269007) <- [6, 1](13.704699910719626) <- [6, 0](13.649110640673518) <- [7, 0](13.0)(Start) 
145 | Path length: 23
146 | Number of nodes created: 112
147 | Execution time: 0.001 seconds
148 |      0   1   2   3   4   5   6   7   8   9   10  11  12
149 |    ╔═══╤═══╤═══╤═══╤═══╤═══╤═══════════╤═══╤═══╤═══╤═══╗
150 | 0  ║   │   │   │   │   │   │ *   *   * │   │   │   │   ║
151 |    ╟───┴───┼───┤   └───┴───┘   ┌───┐   ├───┼───┴───┴───╢
152 | 1  ║       │   │             * │   │ * │   │ *   *   * ║
153 |    ╟───┐   ├───┼───┬───┬───┐   ├───┤   └───┘   ┌───┐   ║
154 | 2  ║   │   │   │   │   │   │ * │   │ *   *   * │   │ o ║
155 |    ╟───┤   └───┼───┼───┴───┘   ├───┤   ┌───┬───┼───┼───╢
156 | 3  ║   │       │   │ *   *   * │   │   │   │   │   │   ║
157 |    ╟───┼───┐   └───┘   ┌───┐   ├───┤   └───┴───┴───┼───╢
158 | 4  ║   │   │         * │   │   │   │               │   ║
159 |    ╟───┼───┼───┬───┐   └───┘   ├───┼───┐   ┌───┬───┼───╢
160 | 5  ║   │   │   │   │ *         │   │   │   │   │   │   ║
161 |    ╟───┴───┴───┴───┘   ┌───┬───┼───┼───┘   └───┴───┼───╢
162 | 6  ║ *   *   *   *   * │   │   │   │               │   ║
163 |    ║   ┌───┐   ┌───┐   └───┴───┼───┤   ┌───┐       ├───╢
164 | 7  ║ S │   │   │   │           │   │   │   │       │   ║
165 |    ╟───┼───┤   ├───┤   ┌───┐   └───┘   └───┘       └───╢
166 | 8  ║   │   │   │   │   │   │                           ║
167 |    ╟───┴───┘   └───┘   └───┘   ┌───┬───┐   ┌───┬───┬───╢
168 | 9  ║                           │   │   │   │   │   │   ║
169 |    ║   ┌───┬───┐   ┌───┬───┐   └───┴───┘   └───┴───┴───╢
170 | 10 ║   │   │   │   │   │   │                           ║
171 |    ║   └───┼───┼───┼───┼───┤   ┌───┬───┬───┬───┬───┬───╢
172 | 11 ║       │   │   │   │   │   │   │   │   │   │   │   ║
173 |    ╚═══════╧═══╧═══╧═══╧═══╧═══╧═══╧═══╧═══╧═══╧═══╧═══╝
174 | 
175 | ```
176 | 
177 | 
178 | 
179 | 
180 | Class diagram
181 | ======
182 | 
183 | 
184 | ![alt image](https://i.imgur.com/Zz69FIL.png)
185 | 
186 | 
187 | About the author
188 | ======
189 | My name is Gabriel, I'm a french student in Video Games Development in Canada
190 | 
191 | 
192 | 
193 | 
194 | 
195 | 
196 | 
197 | [1]:https://github.com/Gaderr/Maze_solver/blob/a6ac782c316adee15d8029a12531a7fcd5f659ef/src/Main.java#L25
198 | 


--------------------------------------------------------------------------------
/bin/.gitignore:
--------------------------------------------------------------------------------
 1 | /AStarSolver$1.class
 2 | /AStarSolver$2.class
 3 | /AStarSolver.class
 4 | /BFS_Solver.class
 5 | /DFS_Solver.class
 6 | /Main.class
 7 | /Maze.class
 8 | /Node.class
 9 | /Solver.class
10 | /Square.class
11 | 


--------------------------------------------------------------------------------
/bin/AStarSolver$1.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/AStarSolver$1.class


--------------------------------------------------------------------------------
/bin/AStarSolver$2.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/AStarSolver$2.class


--------------------------------------------------------------------------------
/bin/AStarSolver.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/AStarSolver.class


--------------------------------------------------------------------------------
/bin/BFS_Solver.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/BFS_Solver.class


--------------------------------------------------------------------------------
/bin/DFS_Solver.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/DFS_Solver.class


--------------------------------------------------------------------------------
/bin/Main.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/Main.class


--------------------------------------------------------------------------------
/bin/Maze.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/Maze.class


--------------------------------------------------------------------------------
/bin/Node.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/Node.class


--------------------------------------------------------------------------------
/bin/Square.class:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrieldrn/Java-Maze-Solver/bcce3969e113fbbb2724a44526962b6182ce566d/bin/Square.class


--------------------------------------------------------------------------------
/data/lab.txt:
--------------------------------------------------------------------------------
1 | XOOOOX
2 | SOXOXX
3 | XOXOXX
4 | XOXOOE
5 | XOXXOX
6 | XOOOOX


--------------------------------------------------------------------------------
/data/lab_big.txt:
--------------------------------------------------------------------------------
 1 | xxx_xx___xxxx
 2 | __x____x_x___
 3 | x_xxxx_x___xe
 4 | x__x___x_xxxx
 5 | xx___x_x____x
 6 | xxxx___xx_xxx
 7 | _____xxx____x
 8 | sx_x___x_x__x
 9 | xx_x_x_______
10 | _______xx_xxx
11 | _xx_xx_______
12 | __xxxx_xxxxxx


--------------------------------------------------------------------------------
/data/test.txt:
--------------------------------------------------------------------------------
1 | -----------------e-
2 | --xxxxxxxxxxxx-----
3 | -------------x-----
4 | ----s--------x-----
5 | -------------x-----
6 | -------------------
7 | -------------------


--------------------------------------------------------------------------------
/src/AStarSolver.java:
--------------------------------------------------------------------------------
  1 | import java.util.AbstractCollection;
  2 | import java.util.Comparator;
  3 | import java.util.Iterator;
  4 | import java.util.LinkedList;
  5 | import java.util.PriorityQueue;
  6 | 
  7 | public class AStarSolver extends Solver
  8 | {
  9 | 	/*
 10 | 	 * Constructor
 11 | 	 * m: The maze to solve
 12 | 	 */
 13 | 	public AStarSolver(Maze m, Boolean manhattan)
 14 | 	{
 15 | 		this.maze = m;
 16 | 		this.result = "";
 17 | 		this.manhattan = manhattan; 
 18 | 		this.frontier = new PriorityQueue<Node<Maze>>(new Comparator<Node<Maze>>()
 19 | 		{
 20 | 			public int compare(Node<Maze> s1, Node<Maze> s2) 
 21 | 		    	{
 22 | 		    		Double sf1 = s1.getContent().getCurrState().getF();
 23 | 		    		Double sf2 = s2.getContent().getCurrState().getF();
 24 | 		    		Double sh1 = s1.getContent().getCurrState().getH();
 25 | 		    		Double sh2 = s2.getContent().getCurrState().getH();
 26 | 		    	
 27 | 		    		if(sf1 > sf2)
 28 | 		    			return 1;
 29 | 		    		else if(sf1 == sf2)
 30 | 		    		{
 31 | 		    			if(sh1 > sh2)
 32 | 		    				return 1;
 33 | 		    			else if(sh1 == sh2)
 34 | 		    				return 0;
 35 | 		    			else
 36 | 		    				return -1;
 37 | 		    		}
 38 | 		    		else
 39 | 		    			return -1;
 40 | 		    	}
 41 | 		});
 42 | 		this.closedSquares = new PriorityQueue<Square>(new Comparator<Square>()
 43 | 		{
 44 | 			public int compare(Square s1, Square s2) 
 45 | 		    	{
 46 | 				Double sf1 = s1.getF();
 47 | 		    		Double sf2 = s2.getF();
 48 | 		    		Double sh1 = s1.getH();
 49 | 		    		Double sh2 = s2.getH();
 50 | 		    	
 51 | 		    		if(sf1 > sf2)
 52 | 		    			return 1;
 53 | 		    		else if(sf1 == sf2)
 54 | 		    		{
 55 | 		    			if(sh1 > sh2)
 56 | 		    				return 1;
 57 | 		    			else if(sh1 == sh2)
 58 | 		    				return 0;
 59 | 		    			else
 60 | 		    				return -1;
 61 | 		    		}
 62 | 		    		else
 63 | 		    			return -1;
 64 | 		    	}
 65 | 		});
 66 | 	}
 67 | 	
 68 | 	public String solve()
 69 | 	{
 70 | 		this.maze.initMaze(); //Re-init maze
 71 | 		
 72 | 		Boolean endfound = false;
 73 | 		this.nodesCounter = 0;
 74 | 		this.pathLength = 0;
 75 | 		
 76 | 		//Compute F value of Starting square
 77 | 		if(manhattan)
 78 | 			this.maze.getStart().calcManhattanH();
 79 | 		else
 80 | 			this.maze.getStart().calcEuclidH();
 81 | 		
 82 | 		this.maze.getStart().calcF();
 83 | 		
 84 | 		//Init data structures
 85 | 		this.frontier.clear(); //Clear frontier Queue
 86 | 		((PriorityQueue<Node<Maze>>) this.frontier).offer(new Node<Maze>(this.maze)); //Adding the first node (Start node) (G is at 0, Start to Start = 0)
 87 | 		this.closedSquares.clear(); //Clear closedSquares
 88 | 		
 89 | 		//Measure run time
 90 | 		long startTime = System.currentTimeMillis();
 91 | 		
 92 | 		while(!endfound)
 93 | 		{
 94 | 			if(this.frontier.isEmpty())
 95 | 				break;
 96 | 			else
 97 | 			{
 98 | 				Node<Maze> current = ((PriorityQueue<Node<Maze>>) this.frontier).remove();
 99 | 				this.maze = (Maze) current.getContent();
100 | 				Square currState = this.maze.getCurrState();
101 | 				
102 | 				if(currState.getCol() == this.maze.getEnd().getCol() && currState.getLine() == this.maze.getEnd().getLine())
103 | 				{
104 | 					Node<Maze> temp = new Node<Maze>(this.maze);
105 | 					temp.setFather(current);
106 | 					((PriorityQueue<Node<Maze>>) this.frontier).offer(temp);
107 | 					endfound = true;
108 | 				}
109 | 				
110 | 				else
111 | 				{
112 | 					LinkedList<Node<Maze>> nexts = this.getNextSquares();
113 | 					if(!this.closedSquares.contains(currState))
114 | 					{
115 | 						this.closedSquares.add(currState);
116 | 						currState.setAttribute("*");
117 | 					}
118 | 					
119 | 					Iterator<Node<Maze>> x = nexts.iterator();
120 | 					
121 | 				    	while(x.hasNext())
122 | 				    	{
123 | 				    		Node<Maze> neighbor = x.next();
124 | 				    	
125 | 				    		if(this.closedSquares.contains(neighbor.getContent().getCurrState()))
126 | 				    			continue;
127 | 				    		else
128 | 				    		{
129 | 				    			if(!this.frontier.contains(neighbor))
130 | 				    			{
131 | 				    				neighbor.setFather(current);
132 | 				    				((PriorityQueue<Node<Maze>>) this.frontier).offer(neighbor);
133 | 				    				this.nodesCounter++;
134 | 				    			}
135 | 				    		}
136 | 				    	}
137 | 				}
138 | 			}
139 | 		}
140 | 		long endTime = System.currentTimeMillis();
141 | 		
142 | 		long time = endTime - startTime;
143 | 		
144 | 		if(this.manhattan)
145 | 			this.result = "    ___                    __  ___            __          __  __            \r\n" + 
146 | 					"   /   | __/|_            /  |/  /___ _____  / /_  ____ _/ /_/ /_____ _____ \r\n" + 
147 | 					"  / /| ||    /  ______   / /|_/ / __ `/ __ \\/ __ \\/ __ `/ __/ __/ __ `/ __ \\\r\n" + 
148 | 					" / ___ /_ __|  /_____/  / /  / / /_/ / / / / / / / /_/ / /_/ /_/ /_/ / / / /\r\n" + 
149 | 					"/_/  |_||/             /_/  /_/\\__,_/_/ /_/_/ /_/\\__,_/\\__/\\__/\\__,_/_/ /_/ \n";
150 | 		else
151 | 			this.result = "    ___                    ______           ___     __\r\n" + 
152 | 					"   /   | __/|_            / ____/_  _______/ (_)___/ /\r\n" + 
153 | 					"  / /| ||    /  ______   / __/ / / / / ___/ / / __  / \r\n" + 
154 | 					" / ___ /_ __|  /_____/  / /___/ /_/ / /__/ / / /_/ /  \r\n" + 
155 | 					"/_/  |_||/             /_____/\\__,_/\\___/_/_/\\__,_/   \n";
156 | 		
157 | 		if(endfound)
158 | 		{
159 | 			this.maze.resetGrid();
160 | 			Node<Maze> revertedTree = ((PriorityQueue<Node<Maze>>) this.frontier).remove();
161 | 			
162 | 			revertedTree = revertedTree.getFather();
163 | 			this.result += "Path: " + this.maze.getEnd().toString() + "(End) <- ";
164 | 			this.pathLength++;
165 | 			
166 | 			while(revertedTree.hasFather())
167 | 			{
168 | 				Maze temp = revertedTree.getContent();
169 | 				Square state = temp.getCurrState();
170 | 				
171 | 				if(!state.equals(this.maze.getEnd()))
172 | 				{
173 | 					this.result += state.toString() + " <- ";
174 | 					this.maze.getGrid()[state.getLine()][state.getCol()].setAttribute("*");
175 | 					this.pathLength++;
176 | 				}
177 | 				revertedTree = revertedTree.getFather();
178 | 			}
179 | 			
180 | 			this.result += this.maze.getStart().toString() + "(Start) \n" + "Path length: " + this.pathLength + "\nNumber of nodes created: " + this.nodesCounter + "\nExecution time: " + time/1000d + " seconds\n";
181 | 			this.result += this.maze.printMaze();
182 | 		}
183 | 		else
184 | 		{
185 | 			this.result += "Failed : Unable to go further and/or end is unreachable.";
186 | 		}
187 | 		
188 | 		return this.result;
189 | 	}
190 | 	
191 | 	/*
192 | 	 *  Get the next ("walkables") squares from the given square
193 | 	 *  c: Square from where to get the nexts squares
194 | 	 */
195 | 	public LinkedList<Node<Maze>> getNextSquares()
196 | 	{
197 | 		LinkedList<Node<Maze>> res = new LinkedList<Node<Maze>>();
198 | 		
199 | 		//Get 4 next squares
200 | 		LinkedList<Maze> nexts = this.maze.getCurrState().getNexts();
201 | 		
202 | 		int gCurrent = this.maze.getCurrState().getG();
203 | 		
204 | 		for(int i = 0; i < nexts.size(); i++)
205 | 		{
206 | 			Square tempSq = nexts.get(i).getCurrState();
207 | 			if(!this.closedSquares.contains(tempSq))
208 | 			{
209 | 				if(this.manhattan)
210 | 					nexts.get(i).getCurrState().calcManhattanH();
211 | 				else
212 | 					nexts.get(i).getCurrState().calcEuclidH();
213 | 				
214 | 				nexts.get(i).getCurrState().incG(gCurrent);
215 | 				
216 | 				nexts.get(i).getCurrState().calcF();
217 | 				
218 | 				Node<Maze> tempNode = new Node<Maze>(nexts.get(i));
219 | 				res.add(tempNode);
220 | 			}
221 | 		}
222 | 		
223 | 		return res;
224 | 	}
225 | 
226 | 	public String getResult() 
227 | 	{
228 | 		if(this.result == "")
229 | 			return "No resolution computed, use the solve method first";
230 | 		else
231 | 			return this.result;
232 | 	}
233 | 	
234 | 	public AbstractCollection<Node<Maze>> getFrontier() 
235 | 	{
236 | 		return this.frontier;
237 | 	}
238 | }
239 | 


--------------------------------------------------------------------------------
/src/BFS_Solver.java:
--------------------------------------------------------------------------------
  1 | import java.util.AbstractCollection;
  2 | import java.util.Iterator;
  3 | import java.util.LinkedList;
  4 | 
  5 | public class BFS_Solver extends Solver
  6 | {
  7 | 	/*
  8 | 	 * Constructor
  9 | 	 * m: Maze to solve
 10 | 	 */
 11 | 	public BFS_Solver(Maze m)
 12 | 	{
 13 | 		this.maze = m;
 14 | 		this.result = "";
 15 | 		this.frontier = new LinkedList<Node<Maze>>();
 16 | 		this.closedSquares = new LinkedList<Square>();
 17 | 	}
 18 | 	
 19 | 	public String solve()
 20 | 	{
 21 | 		Boolean endfound = false;
 22 | 		this.nodesCounter = 0;
 23 | 		this.pathLength = 0;
 24 | 		
 25 | 		//Init maze
 26 | 		this.closedSquares.clear();
 27 | 		this.maze.initMaze();
 28 | 		
 29 | 		//Init frontier
 30 | 		this.frontier.clear();
 31 | 		this.frontier.add(new Node<Maze>(this.maze)); //Add initial state
 32 | 		
 33 | 		//Measure run time
 34 | 		long startTime = System.currentTimeMillis();
 35 | 		
 36 | 		//Search
 37 | 		while(!endfound)
 38 | 		{
 39 | 			if(this.frontier.isEmpty()) //Check if the frontier is empty
 40 | 				break;
 41 | 			
 42 | 			else
 43 | 			{
 44 | 				Node<Maze> current = ((LinkedList<Node<Maze>>) this.frontier).removeFirst(); //Get first node from the frontier
 45 | 				this.maze = (Maze) current.getContent(); //Get maze from the node
 46 | 				Square currState = this.maze.getCurrState(); //Get current state from the maze
 47 | 				
 48 | 				//System.out.println(this.maze.printMaze());
 49 | 				
 50 | 				if(currState.getLine() == this.maze.getEnd().getLine() && currState.getCol() == this.maze.getEnd().getCol())
 51 | 				{
 52 | 					Node<Maze> temp = new Node<Maze>(this.maze);
 53 | 					temp.setFather(current); //Set current as father for all next states
 54 | 					this.frontier.add(temp);
 55 | 					endfound = true;
 56 | 				}
 57 | 				
 58 | 				else
 59 | 				{
 60 | 					LinkedList<Node<Maze>> nexts = this.getNextSquares(); //Get next possible states
 61 | 					if(!this.closedSquares.contains(currState))
 62 | 					{
 63 | 						this.closedSquares.add(currState);
 64 | 						currState.setAttribute("*");
 65 | 					}
 66 | 					
 67 | 					Iterator<Node<Maze>> x = nexts.iterator();
 68 | 					
 69 | 					//Set fathers
 70 | 					while(x.hasNext())
 71 | 					{
 72 | 						Node<Maze> temp = x.next();
 73 | 						temp.setFather(current); //Set current as father for all next states
 74 | 						this.frontier.add(temp);
 75 | 						this.nodesCounter++;
 76 | 					}
 77 | 				}
 78 | 				
 79 | 				//System.out.println(this.frontier.toString());
 80 | 			}
 81 | 		}
 82 | 		
 83 | 		long endTime = System.currentTimeMillis();
 84 | 		
 85 | 		long time = endTime - startTime;
 86 | 		
 87 | 		this.result = "    ____                      ____  __       _______           __     _____                      __  \r\n" + 
 88 | 				"   / __ )________  ____ _____/ / /_/ /_     / ____(_)_________/ /_   / ___/___  ____ ___________/ /_ \r\n" + 
 89 | 				"  / __  / ___/ _ \\/ __ `/ __  / __/ __ \\   / /_  / / ___/ ___/ __/   \\__ \\/ _ \\/ __ `/ ___/ ___/ __ \\\r\n" + 
 90 | 				" / /_/ / /  /  __/ /_/ / /_/ / /_/ / / /  / __/ / / /  (__  ) /_    ___/ /  __/ /_/ / /  / /__/ / / /\r\n" + 
 91 | 				"/_____/_/   \\___/\\__,_/\\__,_/\\__/_/ /_/  /_/   /_/_/  /____/\\__/   /____/\\___/\\__,_/_/   \\___/_/ /_/ \n";
 92 | 	
 93 | 		if(endfound)
 94 | 		{
 95 | 			this.maze.resetGrid();
 96 | 			Node<Maze> revertedTree = ((LinkedList<Node<Maze>>) this.frontier).removeLast();
 97 | 			
 98 | 			revertedTree = revertedTree.getFather();
 99 | 			this.result += "Path: " + this.maze.getEnd().toString() + "(End) <- ";
100 | 			this.pathLength++;
101 | 			
102 | 			while(revertedTree.hasFather())
103 | 			{
104 | 				Maze temp = revertedTree.getContent();
105 | 				Square state = temp.getCurrState();
106 | 				
107 | 				if(!state.equals(this.maze.getEnd()))
108 | 				{
109 | 					this.result += state.toString() + " <- ";
110 | 					this.maze.getGrid()[state.getLine()][state.getCol()].setAttribute("*");
111 | 					this.pathLength++;
112 | 				}
113 | 				revertedTree = revertedTree.getFather();
114 | 			}
115 | 			
116 | 			this.result += this.maze.getStart().toString() + "(Start) \n" + "Path length: " + this.pathLength + "\nNumber of nodes created: " + this.nodesCounter + "\nExecution time: " + time/1000d + " seconds\n";
117 | 			this.result += this.maze.printMaze();
118 | 		}
119 | 		else
120 | 		{
121 | 			this.result += "Failed : Unable to go further and/or end is unreachable.";
122 | 		}
123 | 		
124 | 		return this.result;
125 | 	}
126 | 	
127 | 	public LinkedList<Node<Maze>> getNextSquares()
128 | 	{
129 | 		LinkedList<Node<Maze>> res = new LinkedList<Node<Maze>>();
130 | 		
131 | 		//Get 4 next squares
132 | 		LinkedList<Maze> nexts = this.maze.getCurrState().getNexts();
133 | 		
134 | 		for(int i = 0; i < nexts.size(); i++)
135 | 		{
136 | 			Square tempSq = nexts.get(i).getCurrState();
137 | 			if(!this.closedSquares.contains(tempSq))
138 | 			{
139 | 				//this.closedSquares.add(tempSq);
140 | 				//this.maze.getGrid()[tempSq.getLine()][tempSq.getCol()].setAttribute("*");
141 | 				Node<Maze> tempNode = new Node<Maze>(nexts.get(i));
142 | 				res.add(tempNode); //Add the state
143 | 			}
144 | 		}
145 | 		
146 | 		return res;
147 | 	}
148 | 	
149 | 	public String getResult()
150 | 	{
151 | 		if(result == "")
152 | 			return "No resolution computed, please use BFS_Solver.solve() first";
153 | 		else
154 | 			return this.result;
155 | 	}
156 | 	
157 | 	public AbstractCollection<Node<Maze>> getFrontier() 
158 | 	{
159 | 		return this.frontier;
160 | 	}
161 | }
162 | 


--------------------------------------------------------------------------------
/src/DFS_Solver.java:
--------------------------------------------------------------------------------
  1 | import java.util.AbstractCollection;
  2 | import java.util.Iterator;
  3 | import java.util.LinkedList;
  4 | import java.util.Stack;
  5 | 
  6 | public class DFS_Solver extends Solver
  7 | {
  8 | 	/*
  9 | 	 * Constructor
 10 | 	 * m: The maze to solve
 11 | 	 */
 12 | 	public DFS_Solver(Maze m)
 13 | 	{
 14 | 		this.maze = m;
 15 | 		this.result = "";
 16 | 		this.frontier = new Stack<Node<Maze>>();
 17 | 		this.closedSquares = new Stack<Square>();
 18 | 	}
 19 | 	
 20 | 	public String solve()
 21 | 	{
 22 | 		Boolean endfound = false;
 23 | 		this.nodesCounter = 0;
 24 | 		this.pathLength = 0;
 25 | 		
 26 | 		//Init maze
 27 | 		this.closedSquares.clear();
 28 | 		this.maze.initMaze();
 29 | 		
 30 | 		//Init frontier
 31 | 		this.frontier.clear();
 32 | 		((Stack<Node<Maze>>) this.frontier).push(new Node<Maze>(this.maze)); //Add first state
 33 | 		
 34 | 		//Measure run time
 35 | 		long startTime = System.currentTimeMillis();
 36 | 		
 37 | 		//Search
 38 | 		while(!endfound)
 39 | 		{
 40 | 			if(this.frontier.isEmpty())
 41 | 				break;
 42 | 			
 43 | 			else
 44 | 			{
 45 | 				Node<Maze> current = ((Stack<Node<Maze>>) this.frontier).pop(); //Get first node from the frontier
 46 | 				this.maze = (Maze) current.getContent();
 47 | 				Square currState = this.maze.getCurrState();
 48 | 				
 49 | 				if(currState.getLine() == this.maze.getEnd().getLine() && currState.getCol() == this.maze.getEnd().getCol())
 50 | 				{
 51 | 					Node<Maze> temp = new Node<Maze>(this.maze);
 52 | 					temp.setFather(current);
 53 | 					((Stack<Node<Maze>>) this.frontier).push(temp);
 54 | 					endfound = true;
 55 | 				}	
 56 | 				
 57 | 				else
 58 | 				{
 59 | 					LinkedList<Node<Maze>> nexts = this.getNextSquares(); //Get next possible states
 60 | 					if(!this.closedSquares.contains(currState))
 61 | 					{
 62 | 						((Stack<Square>) this.closedSquares).push(currState);
 63 | 						currState.setAttribute("*");
 64 | 					}
 65 | 					
 66 | 					Iterator<Node<Maze>> x = nexts.descendingIterator();
 67 | 					
 68 | 					while(x.hasNext())
 69 | 					{
 70 | 						Node<Maze> temp = x.next();
 71 | 						temp.setFather(current);
 72 | 						((Stack<Node<Maze>>) this.frontier).push(temp);
 73 | 						this.nodesCounter++;
 74 | 					}
 75 | 				}
 76 | 			}
 77 | 		}
 78 | 		
 79 | 		long endTime = System.currentTimeMillis();
 80 | 		
 81 | 		long time = endTime - startTime;
 82 | 		
 83 | 		this.result = "    ____             __  __       _______           __     _____                      __  \r\n" + 
 84 | 				"   / __ \\___  ____  / /_/ /_     / ____(_)_________/ /_   / ___/___  ____ ___________/ /_ \r\n" + 
 85 | 				"  / / / / _ \\/ __ \\/ __/ __ \\   / /_  / / ___/ ___/ __/   \\__ \\/ _ \\/ __ `/ ___/ ___/ __ \\\r\n" + 
 86 | 				" / /_/ /  __/ /_/ / /_/ / / /  / __/ / / /  (__  ) /_    ___/ /  __/ /_/ / /  / /__/ / / /\r\n" + 
 87 | 				"/_____/\\___/ .___/\\__/_/ /_/  /_/   /_/_/  /____/\\__/   /____/\\___/\\__,_/_/   \\___/_/ /_/ \r\n" + 
 88 | 				"          /_/                                                                             \n";
 89 | 	
 90 | 		if(endfound)
 91 | 		{
 92 | 			this.maze.resetGrid();
 93 | 			Node<Maze> revertedTree = ((Stack<Node<Maze>>) this.frontier).pop();
 94 | 			
 95 | 			revertedTree = revertedTree.getFather().getFather();
 96 | 			this.result += "Path: " + this.maze.getEnd().toString() + "(End) <- ";
 97 | 			this.pathLength++;
 98 | 			
 99 | 			while(revertedTree.hasFather())
100 | 			{
101 | 				Maze temp = revertedTree.getContent();
102 | 				Square state = temp.getCurrState();
103 | 				
104 | 				if(!state.equals(this.maze.getEnd()))
105 | 				{
106 | 					this.result += state.toString() + " <- ";
107 | 					this.maze.getGrid()[state.getLine()][state.getCol()].setAttribute("*");
108 | 					this.pathLength++;
109 | 				}
110 | 				revertedTree = revertedTree.getFather();
111 | 			}
112 | 			
113 | 			this.result += this.maze.getStart().toString() + "(Start) \n" + "Path length: " + this.pathLength + "\nNumber of nodes created: " + this.nodesCounter + "\nExecution time: " + time/1000d + " seconds\n";
114 | 			this.result += this.maze.printMaze();
115 | 		}
116 | 		else
117 | 		{
118 | 			this.result += "Failed : Unable to go further and/or end is unreachable.";
119 | 		}
120 | 		
121 | 		return this.result;
122 | 	}
123 | 	
124 | 	public LinkedList<Node<Maze>> getNextSquares()
125 | 	{
126 | 		LinkedList<Node<Maze>> res = new LinkedList<Node<Maze>>();
127 | 		
128 | 		//Get 4 next squares
129 | 		LinkedList<Maze> nexts = this.maze.getCurrState().getNexts();
130 | 		
131 | 		for(int i = 0; i < nexts.size(); i++)
132 | 		{
133 | 			Square tempSq = nexts.get(i).getCurrState();
134 | 			if(!this.closedSquares.contains(tempSq))
135 | 			{
136 | 				Node<Maze> tempNode = new Node<Maze>(nexts.get(i));
137 | 				res.add(tempNode);
138 | 			}
139 | 		}
140 | 		
141 | 		return res;
142 | 	}
143 | 	
144 | 	public String getResult()
145 | 	{
146 | 		if(result == "")
147 | 			return "No resolution computed, please use DFS_Solver.solve() first";
148 | 		else
149 | 			return this.result;
150 | 	}
151 | 
152 | 	public AbstractCollection<Node<Maze>> getFrontier() 
153 | 	{
154 | 		return  this.frontier;
155 | 	}
156 | }
157 | 


--------------------------------------------------------------------------------
/src/Main.java:
--------------------------------------------------------------------------------
 1 | import java.io.IOException;
 2 | 
 3 | public class Main 
 4 | {
 5 | 	public static void main(String[] args) throws IOException 
 6 | 	{
 7 | 		Square start1 = new Square(1, 0, "S");
 8 | 		Square end1 = new Square(3, 4, "E");
 9 | 		
10 | 		Maze lab1 = new Maze(6, 5, start1, end1);
11 | 		
12 | 		lab1.setMazeWall(2, 0);
13 | 		lab1.setMazeWall(3, 0);
14 | 		lab1.setMazeWall(1, 2);
15 | 		lab1.setMazeWall(2, 2);
16 | 		lab1.setMazeWall(3, 2);
17 | 		lab1.setMazeWall(4, 2);
18 | 		lab1.setMazeWall(4, 3);
19 | 		lab1.setMazeWall(1, 4);
20 | 		lab1.setMazeWall(2, 4);
21 | 		
22 | 		//====================
23 | 		//====================
24 | 
25 | 		Maze lab2 = new Maze("./data/lab.txt");
26 | 		
27 | 		//char[] order = {'W', 'E', 'N', 'S'};
28 | 		//lab2.setOrder(order);
29 | 		
30 | 		//System.out.println(lab2.toString());
31 | 		
32 | 		BFS_Solver b2 = new BFS_Solver(lab2);
33 | 		DFS_Solver d2 = new DFS_Solver(lab2);
34 | 		AStarSolver a2 = new AStarSolver(lab2, true);
35 | 		
36 | 		System.out.println(b2.solve());
37 | 		System.out.println(d2.solve());
38 | 		System.out.println(a2.solve());
39 | 		
40 | 		a2 = new AStarSolver(lab2, false);
41 | 		
42 | 		System.out.println(a2.solve());
43 | 	}
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Maze.java:
--------------------------------------------------------------------------------
  1 | import java.io.BufferedReader;
  2 | import java.io.FileNotFoundException;
  3 | import java.io.FileReader;
  4 | import java.io.IOException;
  5 | 
  6 | public class Maze 
  7 | {
  8 | 	private Square[][] grid;
  9 | 	private Square start;
 10 | 	private Square end;
 11 | 	private Square currState;
 12 | 	public int lMax;
 13 | 	public int cMax;
 14 | 	public char[] order = {'N', 'E', 'S', 'W'}; //Shift order in the grid during solving in cardinals
 15 | 	
 16 | 	/*
 17 | 	 * Constructor with no file
 18 | 	 * lRange: Number of lines in the maze
 19 | 	 * cRange: Number of columns in the maze
 20 | 	 * start: The starting square of the maze
 21 | 	 * end: the ending square of the maze
 22 | 	 */
 23 | 	public Maze(int lRange, int cRange, Square start, Square end)
 24 | 	{
 25 | 		//Init grid
 26 | 		this.grid = new Square[lRange][cRange];
 27 | 		//Set max values
 28 | 		this.lMax = lRange;
 29 | 		this.cMax = cRange;
 30 | 		for(int i = 0; i < lRange; i++)
 31 | 		{
 32 | 			for(int j = 0; j < cRange; j++)
 33 | 			{
 34 | 				this.grid[i][j] = new Square(i,j," ");
 35 | 			}
 36 | 		}
 37 | 		
 38 | 		this.assignMazeToGridSquares();
 39 | 		
 40 | 		//Create start and end MazeState objects contaning the start and end squares (stated)
 41 | 		this.end = end;
 42 | 		this.start = start;
 43 | 		
 44 | 		this.currState = this.getStart();
 45 | 		//At this point, the grid is and stay the inital Maze unsolved.
 46 | 	}
 47 | 	
 48 | 	/*
 49 | 	 * Constructor with file
 50 | 	 * file: .txt file from where to import the maze
 51 | 	 */
 52 | 	public Maze(String filepath) throws IOException
 53 | 	{
 54 | 		try 
 55 | 		{
 56 | 			BufferedReader file = new BufferedReader(new FileReader(filepath));
 57 | 			String line = file.readLine();
 58 | 			String buffer = line.toUpperCase();
 59 | 			int count = 0;
 60 | 			
 61 | 			//Get columns range
 62 | 			this.cMax = line.length();
 63 | 			this.lMax = 1;
 64 | 			
 65 | 			//Get lines range
 66 | 			while((line = file.readLine()) != null)
 67 | 			{
 68 | 				this.lMax++;
 69 | 				buffer += line.toUpperCase();
 70 | 			}
 71 | 			
 72 | 			//Init grid
 73 | 			this.grid = new Square[this.lMax][this.cMax];
 74 | 			
 75 | 			for(int i = 0; i < this.lMax; i++)
 76 | 			{
 77 | 				for(int j = 0; j < this.cMax; j++)
 78 | 				{
 79 | 					switch(buffer.charAt(count++))
 80 | 					{
 81 | 						case 'E': this.setEnd(new Square(i, j, "E"));
 82 | 							break;
 83 | 							
 84 | 						case 'S': this.setStart(new Square(i, j, "S"));
 85 | 							break;
 86 | 							
 87 | 						case 'X': this.grid[i][j] = new Square(i, j, true);
 88 | 							break;
 89 | 							
 90 | 						default : this.grid[i][j] = new Square(i, j, " ");
 91 | 							break;
 92 | 					}
 93 | 				}
 94 | 			}
 95 | 			
 96 | 			file.close();
 97 | 			
 98 | 			this.assignMazeToGridSquares();
 99 | 			
100 | 			this.currState = this.getStart();
101 | 		}
102 | 		catch (FileNotFoundException e) 
103 | 		{
104 | 			e.printStackTrace();
105 | 		}
106 | 	}
107 | 	
108 | 	public Maze(Square[][] grid, Square start, Square end, Square currState, int lMax, int cMax) 
109 | 	{
110 | 		this.grid = grid;
111 | 		this.start = start;
112 | 		this.end = end;
113 | 		this.currState = currState;
114 | 		this.lMax = lMax;
115 | 		this.cMax = cMax;
116 | 	}
117 | 	
118 | 	/*
119 | 	 * Retuns the starting Square
120 | 	 */
121 | 	public Square getStart() 
122 | 	{
123 | 		return start;
124 | 	}
125 | 
126 | 	/*
127 | 	 * Sets the starting Square for the attribute and the grid
128 | 	 * start: The square to set as starting square
129 | 	 */
130 | 	public void setStart(Square start) 
131 | 	{
132 | 		this.start = start;
133 | 		this.grid[start.getLine()][start.getCol()] = start;
134 | 	}
135 | 
136 | 	/*
137 | 	 * Returns the ending Square
138 | 	 */
139 | 	public Square getEnd() 
140 | 	{
141 | 		return end;
142 | 	}
143 | 
144 | 	/*
145 | 	 * Sets the ending Square for the attribute and the grid
146 | 	 * end: The square to set as ending square
147 | 	 */
148 | 	public void setEnd(Square end) 
149 | 	{
150 | 		this.end = end;
151 | 		this.grid[end.getLine()][end.getCol()] = end;
152 | 	}
153 | 	
154 | 	/*
155 | 	 * Sets a wall in the maze
156 | 	 * l: Line position of the wall
157 | 	 * c: Column position of the wall
158 | 	 */
159 | 	public void setMazeWall(int l, int c)
160 | 	{
161 | 		this.grid[l][c].setWall();
162 | 	}
163 | 	
164 | 	public Square getCurrState()
165 | 	{
166 | 		return this.currState;
167 | 	}
168 | 	
169 | 	public void setCurrState(Square c)
170 | 	{
171 | 		this.currState = c;
172 | 	}
173 | 	
174 | 	public void setNextState(Square c)
175 | 	{
176 | 		this.grid[this.currState.getLine()][this.currState.getCol()].setAttribute("*");
177 | 		this.currState = c;
178 | 	}
179 | 	
180 | 	public void assignMazeToGridSquares()
181 | 	{
182 | 		for(int i = 0; i < this.lMax; i++)
183 | 		{
184 | 			for(int j = 0; j < this.cMax; j++)
185 | 			{
186 | 				this.grid[i][j].assignMaze(this);
187 | 			}
188 | 		}
189 | 	}
190 | 	
191 | 	/*
192 | 	 * Initiates the maze
193 | 	 */
194 | 	public void initMaze()
195 | 	{
196 | 		//Init grid
197 | 		this.resetGrid();
198 | 		
199 | 		this.currState = this.getStart();
200 | 	}
201 | 	
202 | 	public void resetGrid()
203 | 	{
204 | 		for(int i = 0; i < this.lMax; i++)
205 | 		{
206 | 			for(int j = 0; j < this.cMax; j++)
207 | 			{
208 | 				if(this.grid[i][j].getAttribute() == "*")
209 | 					this.grid[i][j].setAttribute(" ");
210 | 			}
211 | 		}
212 | 	}
213 | 	
214 | 	/*
215 | 	 * Sets a new shift order
216 | 	 * newOrder: 4 entries char array, each char (in caps) means a shift direction, for example : ['N', 'S', 'W', 'E'] will shifts North -> South -> West -> East.
217 | 	 */
218 | 	public void setOrder(char[] newOrder)
219 | 	{
220 | 		if(newOrder.length == 4)
221 | 		{
222 | 			this.order = newOrder;
223 | 		}
224 | 	}
225 | 	
226 | 	/*
227 | 	 * Resets the default order North -> East -> South -> West (Clockwise)
228 | 	 */
229 | 	public void resetOrder()
230 | 	{
231 | 		char[] o = {'N', 'E', 'S', 'W'}; 
232 | 		this.order = o;
233 | 	}
234 | 
235 | 	/*
236 | 	 * Returns the maze grid
237 | 	 */
238 | 	public Square[][] getGrid() 
239 | 	{
240 | 		return grid;
241 | 	}
242 | 	
243 | 	public Maze clone()
244 | 	{
245 | 		return new Maze(this.grid, this.start, this.end, this.currState, this.lMax, this.cMax);
246 | 	}
247 | 
248 | 	/*
249 | 	 * Get the maze in a unicode box draw format
250 | 	 */
251 | 	public String printMaze()
252 | 	{
253 | 		String res = "   ";
254 | 		String res_under = "";
255 | 		Square temp = null;
256 | 		Square templineunder = null;
257 | 		Square tempnextcol = null;
258 | 		Square tempdiag = null;
259 | 		
260 | 		//Columns numbers
261 | 		for(int i = 0; i < cMax; i++)
262 | 		{
263 | 			if(i < 10)
264 | 				res += "  " + i + " ";
265 | 			else
266 | 				res += "  " + i;
267 | 		}
268 | 		res += "\n   ╔";
269 | 		
270 | 		//First row : Maze top edge
271 | 		for(int i = 1; i < this.cMax; i++)
272 | 		{
273 | 			temp = this.grid[0][i - 1];
274 | 			tempnextcol = this.grid[0][i];
275 | 			if(temp.isWall())
276 | 				res += "═══╤";
277 | 			else
278 | 				if(tempnextcol.isWall())
279 | 					res += "═══╤";
280 | 				else
281 | 					res += "════";
282 | 		}
283 | 		res += "═══╗\n";
284 | 		
285 | 		//Browse all squares
286 | 		// res = the line containing the square states
287 | 		// res_under = the graphics under the squares line with the corner unicode characters
288 | 		// contatenation of res + res_under at each line
289 | 		//Example :
290 | 		//		│   │   │   │ <- res
291 | 		//		└───┼───┼───┘ <- res_under
292 | 		//		    │   │     <- res
293 | 		//		    └───┘     <- res_under
294 | 		//		etc...
295 | 		for(int l = 0; l < this.lMax; l++)
296 | 		{
297 | 			res_under = "";
298 | 			for(int c = 0; c < this.cMax; c++)
299 | 			{
300 | 				//Get Squares
301 | 				temp = this.grid[l][c]; // = A -> Current square
302 | 				tempnextcol = temp.getEast(); // = B -> Square at the right of temp
303 | 				templineunder = temp.getSouth(); // = C -> Square below temp
304 | 				if(l < this.lMax - 1 && c < this.cMax - 1)
305 | 					tempdiag = templineunder.getEast(); // = D -> Square in the temp lower right-hand diagonal
306 | 				
307 | 				if(c == 0) //First colomn of current line l
308 | 				{
309 | 					if(l < 10)
310 | 						res += l + "  ║";
311 | 					else
312 | 						res += l + " ║";
313 | 					
314 | 					if(templineunder != null)
315 | 					{
316 | 						if(temp.isWall() || templineunder.isWall())
317 | 							res_under += "   ╟";
318 | 						else
319 | 							res_under += "   ║";
320 | 					}
321 | 				}
322 | 				
323 | 				if(temp.isWall())
324 | 				{
325 | 					res += "   ";
326 | 					res_under += "───";
327 | 				}
328 | 				else
329 | 				{
330 | 					if(temp.getLine() == this.currState.getLine() && temp.getCol() == this.currState.getCol())
331 | 						res += " o ";
332 | 					else if (temp.getLine() == this.start.getLine() && temp.getCol() == this.start.getCol())
333 | 						res += " S ";
334 | 					else if (temp.getLine() == this.end.getLine() && temp.getCol() == this.end.getCol())
335 | 						res += " E ";
336 | 					else
337 | 						res += " " + temp.getAttribute() + " ";
338 | 					
339 | 					
340 | 					if(l < this.lMax - 1)
341 | 					{
342 | 						if(templineunder.isWall())
343 | 							res_under += "───";
344 | 						else
345 | 							res_under += "   ";
346 | 					}
347 | 				}
348 | 				
349 | 				//Maze right edge
350 | 				if(c == this.cMax - 1)
351 | 				{	
352 | 					res += "║";
353 | 					if(temp != null && templineunder != null)
354 | 					{
355 | 						if(temp.isWall() || templineunder.isWall())
356 | 							res_under += "╢";
357 | 						else
358 | 							res_under += "║";
359 | 					}
360 | 				}
361 | 				else
362 | 				{
363 | 					//Squares corners.
364 | 					// two cases : wall square or not
365 | 					if(temp.isWall())
366 | 					{
367 | 						res += "│";
368 | 						if(templineunder != null && tempdiag != null && tempnextcol != null)
369 | 						{
370 | 							//"┼" = (B + D).(C + D) -> The most reccurent corner to write
371 | 							if((tempnextcol.isWall() || tempdiag.isWall()) && (templineunder.isWall() || tempdiag.isWall()))
372 | 								res_under += "┼";
373 | 							else
374 | 							{		
375 | 								if(!templineunder.isWall() && !tempdiag.isWall() && !tempnextcol.isWall()) //Wall on top left only
376 | 									res_under += "┘";
377 | 								else if(!templineunder.isWall() && !tempdiag.isWall() && tempnextcol.isWall()) // Walls on top
378 | 									res_under += "┴";
379 | 								else if(templineunder.isWall() && !tempdiag.isWall() && !tempnextcol.isWall()) // Walls on left
380 | 									res_under += "┤";
381 | 							}
382 | 						}
383 | 					}
384 | 					else
385 | 					{
386 | 						if(tempnextcol != null)
387 | 						{
388 | 							if(tempnextcol.isWall())
389 | 								res += "│";
390 | 							else
391 | 								res += " ";
392 | 							
393 | 							if(templineunder != null && tempdiag != null)
394 | 							{
395 | 								//"┼" = (C).(D) -> The most reccurent corner to write
396 | 								if(templineunder.isWall() && tempnextcol.isWall())
397 | 									res_under += "┼";
398 | 								else
399 | 								{		
400 | 									if(!templineunder.isWall() && !tempdiag.isWall() && !tempnextcol.isWall()) //No wall
401 | 										res_under += " ";
402 | 									else if(!templineunder.isWall() && tempdiag.isWall() && !tempnextcol.isWall()) //Wall on right below
403 | 										res_under += "┌";
404 | 									else if(templineunder.isWall() && !tempdiag.isWall() && !tempnextcol.isWall()) //Wall on left below
405 | 										res_under += "┐";
406 | 									else if(!templineunder.isWall() && !tempdiag.isWall() && tempnextcol.isWall()) //Wall on top right
407 | 										res_under += "└";
408 | 									else if(!templineunder.isWall() && tempdiag.isWall() && tempnextcol.isWall()) //Walls on right
409 | 										res_under += "├";
410 | 									else if(templineunder.isWall() && tempdiag.isWall() && !tempnextcol.isWall()) //Walls below
411 | 										res_under += "┬";
412 | 								}
413 | 							}
414 | 						}
415 | 					}
416 | 				}
417 | 			}//<- for each column
418 | 			if(l < this.lMax - 1)
419 | 				res += "\n" + res_under + "\n"; //Concatenate res + res_under
420 | 			else
421 | 			{
422 | 				//Maze bottom edge
423 | 				res += "\n   ╚";
424 | 				for(int i = 1; i < this.cMax; i++)
425 | 				{
426 | 					temp = this.getGrid()[l][i - 1];
427 | 					if(temp.getEast().isWall() || temp.isWall())
428 | 						res += "═══╧";
429 | 					else
430 | 						res += "════";
431 | 				}
432 | 				res += "═══╝\n";
433 | 			}
434 | 		}
435 | 		
436 | 		/*//Affichage simple
437 | 		String res = "   ";
438 | 		for(int i = 0; i < cMax; i++)
439 | 		{
440 | 			if(i >= 9)
441 | 				res += " " + i;
442 | 			else
443 | 				res += " " + i + " ";
444 | 		}
445 | 		res += "\n";
446 | 		for(int i = 0; i < this.lMax; i++)
447 | 		{
448 | 			if(i > 9)
449 | 				res += i + " ";
450 | 			else
451 | 				res += i + "  ";
452 | 			
453 | 			for(int j = 0; j < this.cMax; j++)
454 | 			{
455 | 				if(this.getGrid()[i][j].getAttribute() != "" && !this.getGrid()[i][j].isWall())
456 | 					res += "[" + this.getGrid()[i][j].getAttribute() + "]";
457 | 				else
458 | 					res += "[■]";
459 | 			}
460 | 			res += "\n";
461 | 		}*/
462 | 		return res;
463 | 	}
464 | 	
465 | 	public String toString()
466 | 	{
467 | 		return this.currState.toString();
468 | 	}
469 | }
470 | 


--------------------------------------------------------------------------------
/src/Node.java:
--------------------------------------------------------------------------------
 1 | public class Node<T>
 2 | {
 3 | 	private T value;
 4 | 	private Node<T> father;
 5 | 	
 6 | 	/*
 7 | 	 * Constructor
 8 | 	 * c: Content to bind to the Node
 9 | 	 */
10 | 	public Node(T c)
11 | 	{
12 | 		this.value = c;
13 | 		this.father = null;
14 | 	}
15 | 
16 | 	/*
17 | 	 * Returns the content binded to the Node
18 | 	 */
19 | 	public T getContent() 
20 | 	{
21 | 		return value;
22 | 	}
23 | 
24 | 	/*
25 | 	 * Sets the content given to the Node
26 | 	 * value: The content to bind
27 | 	 */
28 | 	public void setContent(T value) 
29 | 	{
30 | 		this.value = value;
31 | 	}
32 | 
33 | 	/*
34 | 	 * Returns the father Node from this Node
35 | 	 */
36 | 	public Node<T> getFather() 
37 | 	{
38 | 		return father;
39 | 	}
40 | 
41 | 	/*
42 | 	 * Sets the the father of this Node
43 | 	 * father: The father to set
44 | 	 */
45 | 	public void setFather(Node<T> father) 
46 | 	{
47 | 		this.father = father;
48 | 	}
49 | 	
50 | 	/*
51 | 	 * Returns true if this Node have a father
52 | 	 */
53 | 	public boolean hasFather()
54 | 	{
55 | 		return this.father != null;
56 | 	}
57 | 	
58 | 	/*
59 | 	 * Returns the link father -> son in a String
60 | 	 */
61 | 	public String printFather()
62 | 	{
63 | 		return this.value.toString() + " <- " + this.father.value.toString(); 
64 | 	}
65 | 	
66 | 	/*
67 | 	 * Returns the toString() method of the content binded to this Node
68 | 	 */
69 | 	public String toString()
70 | 	{
71 | 		return this.getContent().toString();
72 | 	}
73 | }
74 | 


--------------------------------------------------------------------------------
/src/Solver.java:
--------------------------------------------------------------------------------
 1 | import java.util.AbstractCollection;
 2 | import java.util.LinkedList;
 3 | 
 4 | public abstract class Solver 
 5 | {
 6 | 	protected Maze maze;
 7 | 	protected String result;
 8 | 	protected AbstractCollection<Node<Maze>> frontier;
 9 | 	protected AbstractCollection<Square> closedSquares;
10 | 	protected int nodesCounter;
11 | 	protected int pathLength;
12 | 	protected Boolean manhattan;
13 | 	
14 | 	/*
15 | 	 * Solves the maze with the related (BFS, DFS, A*) algorithm and
16 | 	 * sets the result in this format :
17 | 	 * 	- Path trace
18 | 	 *  - Path length
19 | 	 *  - Number of nodes created
20 | 	 *  - The maze with the path written
21 | 	 */
22 | 	public abstract String solve();
23 | 	
24 | 	/*
25 | 	 * Get the nexts ("walkables") squares from the given square
26 | 	 */
27 | 	public abstract LinkedList<Node<Maze>> getNextSquares();
28 | 	
29 | 	/*
30 | 	 * Returns the result from the last solving
31 | 	 */
32 | 	public abstract String getResult();
33 | 	
34 | 	/*
35 | 	 * Returns the frontier from the last solving
36 | 	 */
37 | 	public abstract AbstractCollection<Node<Maze>> getFrontier();
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Square.java:
--------------------------------------------------------------------------------
  1 | import java.lang.Math;
  2 | import java.util.LinkedList;
  3 | 
  4 | public class Square
  5 | {
  6 | 	private Maze maze;
  7 | 	private int l;
  8 | 	private int c;
  9 | 	private String attribute;
 10 | 	private boolean wall;
 11 | 	
 12 | 	private int g;
 13 | 	private double h;
 14 | 	private double f;
 15 | 	
 16 | 	/*
 17 | 	 * Constructor for a "walkable" Square in the maze
 18 | 	 * l: Line position
 19 | 	 * c: Column position
 20 | 	 * a: Square state
 21 | 	 * 		-> S = Start position
 22 | 	 * 		-> E = End position
 23 | 	 * 		-> [Space] = Open
 24 | 	 * 		-> * = Closed (when the solving algorithms run through the maze)
 25 | 	 * 		-> o = Current position
 26 | 	 * 
 27 | 	 * -- Note: The wall attribute will be set as false because it can't be a wall.
 28 | 	 */
 29 | 	public Square(int l, int c, String a)
 30 | 	{
 31 | 		this.l = l;
 32 | 		this.c = c;
 33 | 		this.attribute = a; //S = Start; E = End; ' ' = Playable; * = Closed
 34 | 		this.wall = false;
 35 | 		this.g = 0;
 36 | 		this.h = 0;
 37 | 		this.f = 0;
 38 | 	}
 39 | 	
 40 | 	/*
 41 | 	 * Constructor for a wall square in the maze
 42 | 	 * l: Line poisition
 43 | 	 * c: Column position
 44 | 	 * w: Wall state
 45 | 	 * 		-> Set as true to define the square as a wall
 46 | 	 */
 47 | 	public Square(int l, int c, boolean w)
 48 | 	{
 49 | 		this.l = l;
 50 | 		this.c = c;
 51 | 		this.attribute = null;
 52 | 		this.wall = w;
 53 | 		this.g = 0;
 54 | 		this.h = 0;
 55 | 		this.f = 0;
 56 | 	}
 57 | 	
 58 | 	public void assignMaze(Maze m)
 59 | 	{
 60 | 		this.maze = m;
 61 | 	}
 62 | 
 63 | 	/*
 64 | 	 * Returns the line position of the square in the maze
 65 | 	 */
 66 | 	public int getLine() 
 67 | 	{
 68 | 		return l;
 69 | 	}
 70 | 
 71 | 	/*
 72 | 	 * Sets the line position of the square in the maze
 73 | 	 * l: Line position
 74 | 	 */
 75 | 	public void setLine(int l) 
 76 | 	{
 77 | 		this.l = l;
 78 | 	}
 79 | 
 80 | 	/*
 81 | 	 * Returns the column position of the square in the maze
 82 | 	 */
 83 | 	public int getCol() 
 84 | 	{
 85 | 		return c;
 86 | 	}
 87 | 
 88 | 	/*
 89 | 	 * Sets the column position of the square in the maze
 90 | 	 * c: Column position
 91 | 	 */
 92 | 	public void setCol(int c) 
 93 | 	{
 94 | 		this.c = c;
 95 | 	}
 96 | 	
 97 | 	/*
 98 | 	 * 
 99 | 	 * c: The origin Square from where to get the next squares
100 | 	 */
101 | 	public LinkedList<Maze> getNexts()
102 | 	{
103 | 		LinkedList<Maze> nexts = new LinkedList<Maze>();
104 | 		
105 | 		for(int i = 0; i < 4; i++)
106 | 		{
107 | 			Maze tempMaze = this.maze.clone();
108 | 			
109 | 			if(this.maze.order[i] == 'N')
110 | 			{
111 | 				if(this.getNorth() != null && !this.getNorth().isWall())
112 | 				{
113 | 					tempMaze.setNextState(this.getNorth());
114 | 					nexts.push(tempMaze);
115 | 				}
116 | 			}
117 | 			else if (this.maze.order[i] == 'E')
118 | 			{
119 | 				if(this.getEast() != null && !this.getEast().isWall())
120 | 				{
121 | 					tempMaze.setNextState(this.getEast());
122 | 					nexts.push(tempMaze);
123 | 				}
124 | 			}
125 | 			else if (this.maze.order[i] == 'S')
126 | 			{
127 | 				if(this.getSouth() != null && !this.getSouth().isWall())
128 | 				{
129 | 					tempMaze.setNextState(this.getSouth());
130 | 					nexts.push(tempMaze);
131 | 				}
132 | 			}
133 | 			else if (this.maze.order[i] == 'W')
134 | 			{
135 | 				if(this.getWest() != null && !this.getWest().isWall())
136 | 				{
137 | 					tempMaze.setNextState(this.getWest());
138 | 					nexts.push(tempMaze);
139 | 				}
140 | 			}
141 | 		}
142 | 		return nexts;
143 | 	}
144 | 	
145 | 	/*
146 | 	 * Returns the Square at North from the given Square
147 | 	 * c: The origin Square from where to get the North Square
148 | 	 */
149 | 	public Square getNorth()
150 | 	{
151 | 		if(this.l - 1 < 0)
152 | 			return null;
153 | 		else
154 | 			return this.maze.getGrid()[this.l - 1][this.c];
155 | 	}
156 | 	
157 | 	/*
158 | 	 * Returns the Square at West from the given Square
159 | 	 * c: The origin Square from where to get the West Square
160 | 	 */
161 | 	public Square getWest()
162 | 	{
163 | 		if(this.c - 1 < 0)
164 | 			return null;
165 | 		else
166 | 			return this.maze.getGrid()[this.l][this.c - 1];
167 | 	}
168 | 	
169 | 	/*
170 | 	 * Returns the Square at South from the given Square
171 | 	 * c: The origin Square from where to get the South Square
172 | 	 */
173 | 	public Square getSouth()
174 | 	{
175 | 		if(this.l + 1 == this.maze.lMax)
176 | 			return null;
177 | 		else
178 | 			return this.maze.getGrid()[this.l + 1][this.c];
179 | 	}
180 | 	
181 | 	/*
182 | 	 * Returns the Square at East from the given Square
183 | 	 * c: The origin Square from where to get the East Square
184 | 	 */
185 | 	public Square getEast()
186 | 	{
187 | 		if(this.c + 1 == this.maze.cMax)
188 | 			return null;
189 | 		else
190 | 			return this.maze.getGrid()[this.l][this.c + 1];
191 | 	}
192 | 
193 | 	/*
194 | 	 * Returns the square attribute
195 | 	 * If the square is a wall, it returns null
196 | 	 */
197 | 	public String getAttribute() 
198 | 	{
199 | 		return attribute;
200 | 	}
201 | 
202 | 	/*
203 | 	 * Sets the square attribute
204 | 	 * If the attribute given is not correct, it changes nothing
205 | 	 */
206 | 	public void setAttribute(String attribute) 
207 | 	{
208 | 		if(attribute == " " || attribute == "S" || attribute == "E" || attribute == "*")
209 | 		{
210 | 			this.attribute = attribute;
211 | 			this.wall = false;
212 | 		}
213 | 	}
214 | 
215 | 	/*
216 | 	 * Returns wall attribute
217 | 	 */
218 | 	public boolean isWall()
219 | 	{
220 | 		return this.wall;
221 | 	}
222 | 
223 | 	/*
224 | 	 * Sets the square as a wall
225 | 	 * 		Also sets the square attribute as null
226 | 	 */
227 | 	public void setWall()
228 | 	{
229 | 		this.wall = true;
230 | 		this.attribute = null;
231 | 	}
232 | 	
233 | 	//----------------------
234 | 	// H Value
235 | 	//----------------------
236 | 	
237 | 	/*
238 | 	 * Returns H value
239 | 	 */
240 | 	public double getH()
241 | 	{
242 | 		return this.h;
243 | 	}
244 | 
245 | 	/*
246 | 	 * Computes the H value with the Manhattan distance
247 | 	 * end: The ending Square in the maze
248 | 	 */
249 | 	public void calcManhattanH() 
250 | 	{
251 | 		this.h = Math.abs( this.getLine() - this.maze.getEnd().getLine() ) 
252 | 				 + Math.abs( this.getCol() - this.maze.getEnd().getCol() );
253 | 	}
254 | 	
255 | 	/*
256 | 	 * Computes the H value with the Euclidean distance
257 | 	 * end: The ending Square in the maze
258 | 	 */
259 | 	public void calcEuclidH()
260 | 	{
261 | 		this.h = Math.sqrt(
262 | 					Math.pow( this.getLine() - this.maze.getEnd().getLine(), 2 ) 
263 | 					+ Math.pow( this.getCol() - this.maze.getEnd().getCol(), 2 )
264 | 				);
265 | 	}
266 | 	
267 | 	//----------------------
268 | 	// G Value
269 | 	//----------------------
270 | 
271 | 	/*
272 | 	 * Returns G value
273 | 	 */
274 | 	public int getG() 
275 | 	{
276 | 		return g;
277 | 	}
278 | 	
279 | 	/*
280 | 	 * Increases the G value
281 | 	 */
282 | 	public void incG(int prev)
283 | 	{
284 | 		this.g = 1 + prev;
285 | 	}
286 | 	
287 | 	//----------------------
288 | 	// F Value
289 | 	//----------------------
290 | 	
291 | 	/*
292 | 	 * Computes F value by addition of H and G
293 | 	 */
294 | 	public double calcF()
295 | 	{
296 | 		this.f = this.g + this.h;
297 | 		return this.f;
298 | 	}
299 | 	
300 | 	/*
301 | 	 * Returns F value
302 | 	 */
303 | 	public double getF()
304 | 	{
305 | 		return this.f;
306 | 	}
307 | 	
308 | 	/*
309 | 	 * Returns the Square in a string with the format "[LINE, COLUMN](F)"
310 | 	 */
311 | 	public String toString()
312 | 	{
313 | 		return "[" + this.l + ", " + this.c + "](" + this.f + ")";
314 | 	}
315 | }
316 | 


--------------------------------------------------------------------------------