-
Notifications
You must be signed in to change notification settings - Fork 0
/
Location.java
138 lines (124 loc) · 3.5 KB
/
Location.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/** CMPT_435L_800
* Project 1 -- Maze Solver
* Filename: Location.java
* Student Name: Eric Stenton
* Due Date: February 12, 2020
* Version 1.0
*
* This file contains functions pertaining to the creation of a location object.
* Such objects represent locations within a given maze.
*/
import java.util.Scanner;
/**
* Location
*
* This class defines a location object which provides an iterator for its
* neighbors and defines its own column and row number.
*/
class Location {
final int RIGHT = 0;
final int DOWN = 1;
final int LEFT = 2;
final int UP = 3;
final int DONE = 4;
private int row;
private int col;
int nextDirection; // mutable
/** Location
* parameters: nothing
* return value: nothing
*
* This function serves as the constructor for the Location object. It
* requires no input variables; it initializes the row and col numbers to
* 0 and the nextDirection variable to DONE.
*/
Location() {
row = 0;
col = 0;
nextDirection = DONE;
}
/** start
* parameters: nothing
* return value: nothing
*
* This function simply changes the value of the nextDirection variable to
* RIGHT in order to start the process of determining the correct next step
* from this location.
*/
void start() { // const
nextDirection = RIGHT;
}
/** nextNeighbor
* parameters: nothing
* return value:
* Location -- The location object of the next neighboring location.
*
* This function returns a location object originating as a copy of the
* location object instance. The copy's row or column value is modified
* to change it into the next location to evaluate.
*/
Location nextNeighbor() { // const
// Create a copy
Location p = new Location();
p.row = row;
p.col = col;
if ( nextDirection == RIGHT ) {
p.col++;
} else if ( nextDirection == DOWN ) {
p.row++;
} else if ( nextDirection == LEFT ) {
p.col--;
} else if ( nextDirection == UP ) {
p.row--;
}
nextDirection++;
return p;
}
/** isDone
* parameters: nothing
* return value:
* boolean -- True if the nextDirection variable is equal to DONE and
* false if not.
*
* This function simply checks if there are any more directions to evaluate
* from the current location. If not, it returns true and this location is
* 'done'.
*/
boolean isDone() { // const
return nextDirection == DONE;
}
/** isEqual
* parameters:
* loc -- The location object to test its equality with the current one.
* return value:
* boolean -- True if the provided location object is equal to the
* current one and false if it is not.
*
* This function checks the equality of two location objects by determining
* if their row and column values are the same.
*/
boolean isEqual(Location loc) { // const
return ( row == loc.row && col == loc.col );
}
/** streamOut
* parameters: nothing
* return value: nothing
*
* This function prints the location object's row and column values.
*/
void streamOut() {
System.out.print( row + " " + col );
}
/** streamIn
* parameters:
* input -- A scanner object used to read system input.
* return value: nothing
*
* This function obtains the location's row and column values using the
* provided scanner object.
*/
void streamIn(Scanner input) {
row = input.nextInt();
col = input.nextInt();
}
}