{"id":13726635,"url":"https://github.com/johnridesabike/re-blossom","last_synced_at":"2025-05-07T21:33:26.129Z","repository":{"id":50768111,"uuid":"241746810","full_name":"johnridesabike/re-blossom","owner":"johnridesabike","description":"A Reason implementation of the blossom maximum-matching algorithm","archived":true,"fork":false,"pushed_at":"2021-05-30T13:50:44.000Z","size":1328,"stargazers_count":15,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-11T20:49:11.580Z","etag":null,"topics":["blossom","blossom-algorithm","bucklescript","matching","maximum-matching","reason","reasonml"],"latest_commit_sha":null,"homepage":"https://johnridesa.bike/re-blossom/","language":"Reason","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johnridesabike.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-19T23:10:21.000Z","updated_at":"2023-08-20T16:45:08.000Z","dependencies_parsed_at":"2022-09-11T15:20:09.511Z","dependency_job_id":null,"html_url":"https://github.com/johnridesabike/re-blossom","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnridesabike%2Fre-blossom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnridesabike%2Fre-blossom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnridesabike%2Fre-blossom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnridesabike%2Fre-blossom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnridesabike","download_url":"https://codeload.github.com/johnridesabike/re-blossom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224654340,"owners_count":17347729,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blossom","blossom-algorithm","bucklescript","matching","maximum-matching","reason","reasonml"],"created_at":"2024-08-03T01:03:15.272Z","updated_at":"2024-11-14T16:34:14.550Z","avatar_url":"https://github.com/johnridesabike.png","language":"Reason","funding_links":[],"categories":["Reason"],"sub_categories":[],"readme":"# Re-Blossom 🌺\n\n![GitHub package.json version](https://img.shields.io/github/package-json/v/johnridesabike/re-blossom)\n![Node.js CI](https://github.com/johnridesabike/re-blossom/workflows/Node.js%20CI/badge.svg)\n![GitHub](https://img.shields.io/github/license/johnridesabike/re-blossom)\n\nRe-Blossom is a [Reason](https://reasonml.github.io/) implementation of the\nfamous [blossom algorithm](https://en.wikipedia.org/wiki/Blossom_algorithm). It\nfinds a maximum matching of vertices on general, undirected, weighted graphs.\n\n**[📖 Read the documentation](https://johnridesa.bike/re-blossom/)**\n\n## Notice\n\nIf you're using [ReScript](https://rescript-lang.org), check out\n[ReScript-Blossom](https://github.com/johnridesabike/rescript-blossom). It's\nthe same algorithm, but optimized for a JavaScript environment.\n\nThis package originally had similar optimizations, but I've reworked it to be\nmore compatible with native-Reason. This package currently still relies on\n`bs-platform` to compile to JavaScript, but that's only for testing. All of\nthe core modules should be native-compatible.\n\nI'm not currently using this package in a native environment, so I haven't\nfully converted it yet. If you think you will find this useful, I encourage\nyou to fork it and make the modifications you need.\n\n## Installation\n\nRe-Blossom requires [BuckleScript](https://bucklescript.github.io/) as a peer\ndependency, so you will have to install it separately. Add it by running:\n```sh\nnpm install bs-platform -D\n```\n\nYou can add Re-Blossom to your project by running:\n```sh\nnpm install re-blossom\n```\n\nYou will need to edit your project's `bsconfig.json` file and list Re-Blossom in\nthe `bs-dependencies`.\n```json\n{\n  \"bs-dependencies\": [\n    \"re-blossom\"\n  ]\n}\n```\n\n## Development\n\nDownload the code:\n```sh\ngit clone https://github.com/johnridesabike/re-blossom.git\n```\nIf you want to make your own changes, then it's recommended to fork the\nrepository on GitHub and clone your forked version.\n\nInstall the dependencies:\n```sh\nnpm install\n```\n\nCompile a production build:\n```sh\nnpm run build\n```\n\nRun the Reason watcher (not necessary if your IDE automatically compiles\nReason):\n```sh\nnpm run start\n```\n\nRun the tests:\n```sh\nnpm run test\n```\n\nRun benchmarks that compare it to the similar JavaScript algorithm:\n```sh\nnpm run bench\n```\n\nRun benchmarks in a browser:\n```sh\nnpm run browser\n```\nThen open the URL provided and navigate to the `__benchmarks__` directory.\n\nTo turn on debug logging, enable [bs-log](https://github.com/MinimaHQ/bs-log)\nwith the `BS_LOG` environmental variable:\n```sh\nBS_LOG=re-blossom=* npm run build\n\n# or with your editor\n\nBS_LOG=re-blossom=* vim\n```\n\nWhen reading the code, you may need familiarity with BuckleScript's\n[uncurrying](https://bucklescript.github.io/docs/en/function#solution-guaranteed-uncurrying),\nas well as its map and set structures.\n\nThis code uses many terms and ideas from\n[\"Efficient algorithms for finding maximum matching in graphs\" by Zvi Galil, *ACM Computing Surveys*, 1986](https://doi.org/10.1145/6462.6502).\nReading the paper will make this code much more understandable.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnridesabike%2Fre-blossom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnridesabike%2Fre-blossom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnridesabike%2Fre-blossom/lists"}