Comments (2)
You've hit on a very salient API point. The core issue here is that immutable objects in JS are not super straightforward, and have performance issues (or at least used to). But immutability gets us some very useful properties. The API I'd like to implement is actually pretty close to Rust semantics:
- Immutable by default.
- Mutable when there is a single owner.
- Clone an immutable object if you want a mutable copy.
The problem is that JavaScript mutability is scoped by the object, not its ownership. So I've put off the issue. I suspect the best approach is to:
- Move the data into private fields.
- Provide read-only accessors for the data if needed.
- Provide a version of the class that allows modifications, and either:
- Provide a function to freeze the object.
- Let people keep it mutable and hope they don't accidentally rely on immutability properties.
One way to avoid the latter would be to have some sort of mutation class, similar to a builder but specifically for mutating objects. We already have this kind of operation for Move
, but it would have to be pretty flexible for KPattern
and KTransformation
. Other options might include:
- Accessors with copy-on-write semantics.
- A special handle to modify an object, which you can only (optionally) get at construction time.
I don't really have a great answer, but I would recommend the following for now:
- Treat
KPattern
andKTransformation
as immutable. - Use a function like this when you need a mutable version:
function mutationSafeClone(kpattern: KPattern): KPattern {
return new KPattern(kpattern.kpuzzle, structuredClone(kpattern.patternData));
}
This is in fact what we do inside the codebase when we need a mutable copy.
This all needs a much better answer, but given that you're the first person to run into this issue in 2 years I'm hoping structuredClone(…)
works for you until we have a long-term approach.
from cubing.js.
Yeah, I'm using the cloning approach as a workaround and it's good enough. I just have to keep this in mind whenever I want to make changes to a pattern. But those cases should be quite rare.
I mainly wanted to raise visibility on this issue in case it wasn't known. I agree with your assessment and it sounds like a lot of work for a rather small benefit currently.
from cubing.js.
Related Issues (20)
- [cubing.js issue] Something broke at least with PG3D visualization after 0.46.0 update HOT 3
- Nextjs experimentalAddMove applies move twice HOT 3
- [Twizzle issue] Twizzle deployment 500's for Square-1 reconstructions HOT 3
- [cubing.js issue] Incomplete turns in `<twisty-alg-viewer>` HOT 2
- [Feature request] Standalone controle panel elements, custom styling for components HOT 6
- [cubing.js issue] Detect partial solve HOT 4
- [Feature request] need a parameter to adjust speed of animation HOT 2
- [cubing.js issue] Scale of experimental-2D-LL sides stickers is inconsistent between cubes HOT 2
- How to change TwistyPlayer render size? HOT 6
- [Feature request] Disable initial fade in of twisty-player HOT 2
- [cubing.js issue] With angular Twisty player cannot load HOT 9
- `cubing.js` compatibility notes
- [Feature request] - Some feedback after building a cfop tutorials page vs supported stickering or masking profiles HOT 3
- Cube rotations cause simultaneous moves to break HOT 4
- Svelte / SvelteKit Module Worker Errors HOT 1
- [Twizzle issue] Incorrect GAP and Schreier-Sims permutation in PuzzleGeometry for icosamate HOT 2
- [cubing.js issue] Malformed types published with `v0.48.3` HOT 1
- [cubing.js issue] typo docs: decivingly - deceivingly HOT 1
- [Feature request] Validate moves for experimentalAddMove() HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cubing.js.