kmc7468/cs220
1
0
Fork 0
mirror of https://github.com/kmc7468/cs220.git synced 2025-12-12 21:08:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #243 from AnHaechan/main

Browse Source 
fix: cargo doc, grading script
This commit is contained in:
Jeehoon Kang
2023-08-28 09:29:43 +09:00
committed by GitHub
parent f3307750f5 1feb29dfd2
commit 48f66a94a2
31 changed files with 163 additions and 433 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -138,6 +138,15 @@ Make sure that you're capable of using the following development tools:
- We'll announce **all** assignments before the semester begins.
- Submit your solution to <https://gg.kaist.ac.kr/course/17>.
- Read the documentation at <https://cp.kaist.ac.kr/cs220/cs220/>.
- You can check your grade of each assignment by running the grading script.
- You can run the grading script with the following command:
```bash
$ ./scripts/grade.sh <assignment_number>
```
- E.g. To grade `assignment09`, run the following command:
```bash
$ ./scripts/grade.sh 9
```
- You're **allowed** to use ChatGPT or other LLMs. Instead, you'll solve more problems than previous semesters.

33
scripts/grade-01.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment01")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-02.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment02")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-03.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment03")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-04.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment04")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-06.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment06")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-07.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment07")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-08.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment08")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-09.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment09")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-10.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment10")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-11.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment11")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-12.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment12")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

33
scripts/grade-13.sh
View File

@@ -1,33 +0,0 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNERS=(
"cargo"
"cargo --release"
"cargo_asan"
"cargo_asan --release"
"cargo_tsan"
"cargo_tsan --release"
)
# Lints.
run_linters || exit 1
# Executes test for each runner.
for RUNNER in "${RUNNERS[@]}"; do
echo "Running with $RUNNER..."
TESTS=("--lib assignment13")
if [ $(run_tests) -ne 0 ]; then
exit 1
fi
done
exit 0

18
scripts/grade-utils.sh
View File

@@ -76,17 +76,19 @@ _run_tests_with() {
exit 1
fi
local FAILED=0
for TEST in "${TESTS[@]}"; do
local TEST_CMD="$CARGO test $* $TEST"
timeout ${TIMEOUT:-20s} bash -c "$TEST_CMD 2>/dev/null" 1>&2
local PASSED=0
# local NUM_TESTS=$(echo $TESTS | wc -w)
for TEST in ${TESTS[@]}; do
local TEST_CMD="$CARGO test $* --lib -- $TEST"
timeout ${TIMEOUT:-20s} bash -c "$TEST_CMD 2> /dev/null" 1>&2
case $? in
0) ;;
124) echo_err "Test timed out: $TEST_CMD"; FAILED=$((FAILED + 1));;
*) echo_err "Test failed: $TEST_CMD"; FAILED=$((FAILED + 1));;
0) PASSED=$((PASSED + 1));;
124) echo_err "Test timed out: $TEST_CMD";;
*) echo_err "Test failed: $TEST_CMD";;
esac
done
echo $FAILED
echo $PASSED
}
# example: run_tests

115
scripts/grade.sh Executable file
View File

@@ -0,0 +1,115 @@
#!/usr/bin/env bash
set -e
set -uo pipefail
IFS=$'\n\t'
# Imports library.
BASEDIR=$(dirname "$0")
source $BASEDIR/grade-utils.sh
RUNNER="cargo"
# Lints.
run_linters || exit 1
# Executes test for each runner.
echo "Running with $RUNNER..."
if [ $# != 1 ]
then
echo "==============================="
echo "Invalid argument."
echo "Usage: './grade.sh <assignment_number>'"
echo "Example: './grade.sh 1' to grade assignment01"
exit 1
fi
TEST_NAME=$(printf "TEST%02d" $1)
case $TEST_NAME in
TEST01)
TESTS=(
"assignments::assignment01::small_exercises_grade::test"
)
;;
TEST02)
TESTS=(
"assignments::assignment02::small_exercises_grade::test"
"assignments::assignment02::vec_and_mat_grade::test"
)
;;
TEST03)
TESTS=(
"assignments::assignment03::custom_operators_grade::test"
"assignments::assignment03::parse_shell_grade::test"
"assignments::assignment03::small_exercises_grade::test"
)
;;
TEST04)
TESTS=(
"assignments::assignment04::grade::test"
)
;;
TEST06)
TESTS=(
"assignments::assignment06::semiring_grade::test"
"assignments::assignment06::symbolic_differentiation_grade::test"
)
;;
TEST07)
TESTS=(
"assignments::assignment07::generator_grade::test"
"assignments::assignment07::my_itertools_grade::test"
"assignments::assignment07::small_exercises_grade::test"
"assignments::assignment07::transform_grade::test"
)
;;
TEST08)
TESTS=(
"assignments::assignment08::church_grade::test"
"assignments::assignment08::small_exercises_grade::test"
)
;;
TEST09)
TESTS=(
"assignments::assignment09::bigint_grade::test"
"assignments::assignment09::small_exercises_grade::test"
)
;;
TEST10)
TESTS=(
"assignments::assignment10::labyrinth_grade::test"
"assignments::assignment10::small_exercises_grade::test"
)
;;
TEST11)
TESTS=(
"assignments::assignment11::graph_grade::test_graph"
"assignments::assignment11::linked_list_grade::test_linked_list"
"assignments::assignment11::mock_storage_grade::test_mock_storage"
"assignments::assignment11::tv_room_grade::test_tv_room"
)
;;
TEST12)
TESTS=(
"assignments::assignment12::card_grade"
"assignments::assignment12::demux_grade::test_demux"
"assignments::assignment12::funnel_grade::test_funnel"
"assignments::assignment12::small_exercises_grade::test_pingpong"
)
;;
TEST13)
TESTS=(
"assignments::assignment13::small_exercises_grade::test"
)
;;
*)
echo_err "Invalid assignment number: $1"
echo_err "Assignment number should be within 1 to 12."
exit 1
;;
esac
# Runs tests.
SCORE=$(run_tests)
NUM_TESTS=${#TESTS[@]}
echo Your score: ${SCORE}/${NUM_TESTS}

4
src/assignments/assignment01/mod.rs
View File

@@ -3,8 +3,8 @@
//! The primary goal of this assignment is bringing up SSH, VSCode, and all the other necessary tools to develop Rust programs.
//! Please make sure you're comfortable with developing Rust programs before moving on to the next assignments.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-01.sh` works fine.
//! See `assigment01/small_exercises_grade.rs` and `/scripts/grade-01.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 1` works fine.
//! See `assigment01/small_exercises_grade.rs` and `/scripts/grade.sh 1` for the test script.
pub mod small_exercises;
mod small_exercises_grade;

4
src/assignments/assignment01/small_exercises.rs
View File

@@ -1,8 +1,8 @@
//! Assignment 1: Preparing Rust Development Environment.
//! Welcome to the CS220 course!
//!
//! You should fill out `add()` and `sub()` function bodies in such a way that `/scripts/grade-01.sh` works fine.
//! See `small_problems_grade.rs` and `/scripts/grade-01.sh` for the test script.
//! You should fill out `add()` and `sub()` function bodies in such a way that `/scripts/grade.sh 1` works fine.
//! See `small_problems_grade.rs` and `/scripts/grade.sh 1` for the test script.
//!
//! Hint: <https://doc.rust-lang.org/std/primitive.usize.html>

4
src/assignments/assignment02/mod.rs
View File

@@ -3,8 +3,8 @@
//! The primary goal of this assignment is to re-learn the common programming concepts in Rust, especially those in the Rust Book chapters 3 and 5.
//! Please make sure you're comfortable with the concepts to proceed on to the next assignments.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-02.sh` works fine.
//! See `assigment02/*_grade.rs` and `/scripts/grade-02.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 2` works fine.
//! See `assigment02/*_grade.rs` and `/scripts/grade.sh 2` for the test script.
pub mod small_exercises;
mod small_exercises_grade;

4
src/assignments/assignment03/mod.rs
View File

@@ -1,7 +1,7 @@
//! Assignment 3: Mastering common programming concepts (2/2)
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-03.sh` works fine.
//! See `assignment03/*_grade.rs` and `/scripts/grade-03.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 3` works fine.
//! See `assignment03/*_grade.rs` and `/scripts/grade.sh 3` for the test script.
pub mod small_exercises;
mod small_exercises_grade;

4
src/assignments/assignment04/mod.rs
View File

@@ -11,8 +11,8 @@
//!
//! For calculator, just reading `syntax.rs` would suffice for you to understand what to do.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-04.sh` works fine.
//! See `assignment04/grade.rs` and `/scripts/grade-04.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 4` works fine.
//! See `assignment04/grade.rs` and `/scripts/grade.sh 4` for the test script.
//! Run `/scripts/prepare-submissions.sh` and submit `/target/assignment04.zip` to <https://gg.kaist.ac.kr>.
pub mod context;

4
src/assignments/assignment06/mod.rs
View File

@@ -2,8 +2,8 @@
//!
//! The primary goal of this assignment is to understand generics, traits, and lifetimes.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-06.sh` works fine.
//! See `assignment06/*_grade.rs` and `/scripts/grade-06.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 6` works fine.
//! See `assignment06/*_grade.rs` and `/scripts/grade.sh 6` for the test script.
pub mod semiring;
pub mod symbolic_differentiation;

2
src/assignments/assignment06/symbolic_differentiation.rs
View File

@@ -6,7 +6,7 @@ use std::ops::*;
/// Rational number represented by two isize, numerator and denominator.
///
/// Each Rational number should be normalized so that `demoninator` is nonnegative and `numerator` and `demoninator` are coprime.
/// See [`normalize`] for examples. As a corner case, 0 is represented by Rational { numerator: 0, demoninator: 0 }.
/// See `normalize` for examples. As a corner case, 0 is represented by Rational { numerator: 0, demoninator: 0 }.
///
/// For "natural use", Rational also overloads standard arithmetic operations, i.e, `+`, `-`, `*`, `/`.
///

4
src/assignments/assignment07/mod.rs
View File

@@ -2,8 +2,8 @@
//!
//! The primary goal of this assignment is to understand generics, traits, and lifetimes.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-07.sh` works fine.
//! See `assignment07/*_grade.rs` and `/scripts/grade-07.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 7` works fine.
//! See `assignment07/*_grade.rs` and `/scripts/grade.sh 7` for the test script.
pub mod generator;
pub mod my_itertools;

4
src/assignments/assignment08/mod.rs
View File

@@ -2,8 +2,8 @@
//!
//! The primary goal of this assignment is to get used to first-class functions.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-08.sh` works fine.
//! See `assignment08/*_grade.rs` and `/scripts/grade-08.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 8` works fine.
//! See `assignment08/*_grade.rs` and `/scripts/grade.sh 8` for the test script.
pub mod church;
pub mod small_exercises;

2
src/assignments/assignment09/bigint.rs
View File

@@ -11,7 +11,7 @@ use std::{iter::zip, ops::*};
/// For example, the vector `vec![44,345,3]` represents the integer
/// `44 * (2^32)^2 + 345 * (2^32) + 3`,
/// and the vector `vec![u32::MAX - 5, u32::MAX - 7]` represents the integer
/// `- (5 * 2^32 + 8)
/// `- (5 * 2^32 + 8)`
///
/// You will implement the `Add` and `Sub` trait for this type.
///

4
src/assignments/assignment09/mod.rs
View File

@@ -2,8 +2,8 @@
//!
//! The primary goal of this assignment is to get used to iterators.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-09.sh` works fine.
//! See `assignment09/*_grade.rs` and `/scripts/grade-09.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 9` works fine.
//! See `assignment09/*_grade.rs` and `/scripts/grade.sh 9` for the test script.
pub mod bigint;
pub mod matmul;

4
src/assignments/assignment10/mod.rs
View File

@@ -1,8 +1,8 @@
//! Assignment 10: Iterators (2/2).
//! The primary goal of this assignment is to get used to iterators.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-10.sh` works fine.
//! See `assignment10/*_grade.rs` and `/scripts/grade-10.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 10` works fine.
//! See `assignment10/*_grade.rs` and `/scripts/grade.sh 10` for the test script.
pub mod labyrinth;
pub mod small_exercises;

2
src/assignments/assignment11/graph.rs
View File

@@ -90,7 +90,7 @@ impl SubGraph {
}
/// Returns true iff the subgraph contains a cycle. Nodes that do not belong to this subgraph
/// are ignored. See https://en.wikipedia.org/wiki/Cycle_(graph_theory) for an algorithm.
/// are ignored. See <https://en.wikipedia.org/wiki/Cycle_(graph_theory)> for an algorithm.
pub fn detect_cycle(&self) -> bool {
todo!()
}

4
src/assignments/assignment11/mod.rs
View File

@@ -1,7 +1,7 @@
//! Assignment 11: Familiarizing with smart pointers.
//!
//! You should fill out `todo!()` placeholders in such a way that `/scripts/grade-11.sh` works fine.
//! See `assignment11/*_grade.rs` and `/scripts/grade-11.sh` for the test script.
//! You should fill out `todo!()` placeholders in such a way that `/scripts/grade.sh 11` works fine.
//! See `assignment11/*_grade.rs` and `/scripts/grade.sh 11` for the test script.
//! Run `/scripts/prepare-submissions.sh` and submit `/target/assignment11.zip` to <https://gg.kaist.ac.kr>.
pub mod graph;

4
src/assignments/assignment12/mod.rs
View File

@@ -2,8 +2,8 @@
//!
//! The primary goal of this assignment is to get used to concurrency.
//!
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-12.sh` works fine.
//! See `assignment12/*_grade.rs` and `/scripts/grade-12.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 12` works fine.
//! See `assignment12/*_grade.rs` and `/scripts/grade.sh 12` for the test script.
pub mod card;
pub mod demux;

4
src/assignments/assignment13/mod.rs
View File

@@ -3,8 +3,8 @@
//! The primary goal of this assignment is to get used to data parallelism.
//!
//! Refer to your solution for assignment 09. You will implement the parallelized version of assignment 09.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade-13.sh` works fine.
//! See `assignment13/small_exercises_grade.rs` and `/scripts/grade-13.sh` for the test script.
//! You should fill out the `todo!()` placeholders in such a way that `/scripts/grade.sh 13` works fine.
//! See `assignment13/small_exercises_grade.rs` and `/scripts/grade.sh 13` for the test script.
pub mod small_exercises;
mod small_exercises_grade;