aboutsummaryrefslogtreecommitdiff
path: root/rust/queen-attack/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'rust/queen-attack/README.md')
-rw-r--r--rust/queen-attack/README.md107
1 files changed, 107 insertions, 0 deletions
diff --git a/rust/queen-attack/README.md b/rust/queen-attack/README.md
new file mode 100644
index 0000000..044e2cb
--- /dev/null
+++ b/rust/queen-attack/README.md
@@ -0,0 +1,107 @@
1# Queen Attack
2
3Given the position of two queens on a chess board, indicate whether or not they
4are positioned so that they can attack each other.
5
6In the game of chess, a queen can attack pieces which are on the same
7row, column, or diagonal.
8
9A chessboard can be represented by an 8 by 8 array.
10
11So if you're told the white queen is at (2, 3) and the black queen at
12(5, 6), then you'd know you've got a set-up like so:
13
14```text
15_ _ _ _ _ _ _ _
16_ _ _ _ _ _ _ _
17_ _ _ W _ _ _ _
18_ _ _ _ _ _ _ _
19_ _ _ _ _ _ _ _
20_ _ _ _ _ _ B _
21_ _ _ _ _ _ _ _
22_ _ _ _ _ _ _ _
23```
24
25You'd also be able to answer whether the queens can attack each other.
26In this case, that answer would be yes, they can, because both pieces
27share a diagonal.
28
29## Rust Installation
30
31Refer to the [exercism help page][help-page] for Rust installation and learning
32resources.
33
34## Writing the Code
35
36Execute the tests with:
37
38```bash
39$ cargo test
40```
41
42All but the first test have been ignored. After you get the first test to
43pass, open the tests source file which is located in the `tests` directory
44and remove the `#[ignore]` flag from the next test and get the tests to pass
45again. Each separate test is a function with `#[test]` flag above it.
46Continue, until you pass every test.
47
48If you wish to run all ignored tests without editing the tests source file, use:
49
50```bash
51$ cargo test -- --ignored
52```
53
54To run a specific test, for example `some_test`, you can use:
55
56```bash
57$ cargo test some_test
58```
59
60If the specific test is ignored use:
61
62```bash
63$ cargo test some_test -- --ignored
64```
65
66To learn more about Rust tests refer to the [online test documentation][rust-tests]
67
68Make sure to read the [Modules][modules] chapter if you
69haven't already, it will help you with organizing your files.
70
71## Further improvements
72
73After you have solved the exercise, please consider using the additional utilities, described in the [installation guide](https://exercism.io/tracks/rust/installation), to further refine your final solution.
74
75To format your solution, inside the solution directory use
76
77```bash
78cargo fmt
79```
80
81To see, if your solution contains some common ineffective use cases, inside the solution directory use
82
83```bash
84cargo clippy --all-targets
85```
86
87## Submitting the solution
88
89Generally you should submit all files in which you implemented your solution (`src/lib.rs` in most cases). If you are using any external crates, please consider submitting the `Cargo.toml` file. This will make the review process faster and clearer.
90
91## Feedback, Issues, Pull Requests
92
93The [exercism/rust](https://github.com/exercism/rust) repository on GitHub is the home for all of the Rust exercises. If you have feedback about an exercise, or want to help implement new exercises, head over there and create an issue. Members of the rust track team are happy to help!
94
95If you want to know more about Exercism, take a look at the [contribution guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md).
96
97[help-page]: https://exercism.io/tracks/rust/learning
98[modules]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html
99[cargo]: https://doc.rust-lang.org/book/ch14-00-more-about-cargo.html
100[rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html
101
102## Source
103
104J Dalbey's Programming Practice problems [http://users.csc.calpoly.edu/~jdalbey/103/Projects/ProgrammingPractice.html](http://users.csc.calpoly.edu/~jdalbey/103/Projects/ProgrammingPractice.html)
105
106## Submitting Incomplete Solutions
107It's possible to submit an incomplete solution so you can see how others have completed the exercise.