https://github.com/nguyenvukhang/modtree-rust

https://github.com/nguyenvukhang/modtree-rust

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nguyenvukhang/modtree-rust
• Owner: nguyenvukhang
• Created: 2022-12-10T03:03:08.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-22T09:52:58.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T17:27:41.238Z (8 months ago)
• Language: Rust
• Size: 10.7 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Roadmap

**Stretch goal**: Select some modules, and get all possible min-routes

(no unnecessary modules) through them, ranked by length. Filter by

particular node requirements (module, year, sem), and number of mods

per sem.

**Goal**: Select some modules, `modtree` outputs a Semester List of

which modules to take when. Hard-coded maximum of 5 mods per sem.

## Endgame I/O

Inputs

- input modules that will be done by which year, which sem.

- these are `condition` modules: won't be decided by the algo.

- input modules that want to be done by which year, which sem.

- these are `target` modules: required to be done else query fails.

- input module limit per sem.

Processing

> since everything here is planning for the future, data from the most

> current AY will be used.

- Global-flatten all `target` modules's prereqtrees.

- Combine them to one set.

- Remove the `condition` modules.

- Sort them topologically into a queue.

- Poll this queue repeatedly, filling in each sem in the plan.

- Constantly check for sem availability.

- Prioritize `target` modules.

- Every time a sem is incremented, check the `condition` modules for

  updates.

## Mid-impl optimization ideas

- cache full modules to memory to be reduce calls to db

  (global_flatten and topological_sort both use similar calls)

## Module completion

Pre-requisite trees are not going to be directly related to inter-node

relations.

They will only define the `Percentage of Completion` of a module.

In a user's graph, each module will be assigned a value. Call it

"Modules left to unlock." Completed modules will be assigned '0'.

As you complete modules, you will inadvertently half-complete the

pre-requisite of some modules. Call those modules `Modules Up Next`.

Conditions for a module to be Up Next:

- must have more than one pre-requisite.

- at least one pre-requisite is completed by the user.

- [FUTURE] account for semester-exclusive modules

For consistency, only modules that have pre-requsites that are

completed by the user are shown.

As you complete more modules, more Modules Up Next will show up, and

their Completion state will be shown too.