Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Basic cube representation types #3

Merged
merged 3 commits into from
Mar 13, 2020
Merged

Basic cube representation types #3

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4895ffd
Basic cube representation types
hoisinberg Mar 7, 2020
65b5b95
Renaming non-react files to .ts from .tsx and upgrades static factory…
hoisinberg Mar 13, 2020
c686698
Adds SlotNumber and FaceletNumber type aliases
hoisinberg Mar 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/lib/core/cube.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { CubeIndex } from "./cubeindex"
import { CubeOp } from "./cubeop"

export interface Cube {
readonly dimension: number;
readonly positionOf: (facelet: number) => CubeIndex;
readonly occupantOf: (position: CubeIndex) => number;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idk if you want to add more context to these primitives (e.g. number). But if so, you can make type aliases:

type Facelet = number;
type Color = "red" | "white" | "blue" | "green" | "orange" | "yellow"

then reference the alias instead of number

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think he might want to abstract way from specific colors and just be able to use facelet indicies, in which case I don't think there's a simple way where we can enforce that type

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, the color was just meant to show what you can do with types. The Facelet = number is the more relevant example.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's neat. Done.

readonly apply: (op: CubeOp) => Cube;
}
20 changes: 20 additions & 0 deletions src/lib/core/cubeindex.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
export interface CubeIndex {
readonly face: number;
readonly row: number;
readonly column: number;
}

export namespace CubeIndex {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think namespaces are discouraged (or rather, not preferred) in TS/JS. Will need @itstang to fact check me on this, but for es6 the file itself is effectively the "namespace":
https://michelenasti.com/2019/01/23/is-typescript-namespace-feature-deprecated.html
microsoft/TypeScript#30994

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to keep the grouping you can also make it an object. Or, I see dimension as an argument for both functions. You could curry that out and make this a factory.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 would probably recommend using es6 standard modules over namespaces

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. I've moved the static factory methods into a factory object.

export function fromSlotNumber(slotNumber: number, dimension: number): CubeIndex {
const dimSquared = dimension ** 2;
return {
face: Math.trunc(slotNumber / dimSquared),
row: Math.trunc((slotNumber % dimSquared) / dimension),
column: slotNumber % dimension
}
}

export function toSlotNumber(position: CubeIndex, dimension: number): number {
return ((dimension ** 2) * position.face) + (dimension * position.row) + position.column;
}
}
6 changes: 6 additions & 0 deletions src/lib/core/cubeop.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { CubeIndex } from "./cubeindex"

export interface CubeOp {
readonly imageOf: (cubeIndex: CubeIndex, dimension: number) => CubeIndex;
readonly inverse: () => CubeOp;
}