-
Notifications
You must be signed in to change notification settings - Fork 5
docs(itensorlike): improve documentation — layout, Complex64, API conventions #355
Copy link
Copy link
Open
Description
Summary
Several documentation gaps identified during feature testing of tensor4all-itensorlike.
Issues
Missing documentation
- Column-major data layout not mentioned in crate README. Users need to know
TensorDynLen::from_denseexpects column-major data. - No Complex64 examples in README — all examples use f64 only.
- Inner product conjugation convention (
inner()computes<self|other>with conjugation onself) not prominently documented. with_nsweeps()convenience method not mentioned in README alongsidewith_nhalfsweeps().
API discoverability
IndexLiketrait must be imported for.dim()onDynIndex— consider re-exporting fromtensor4all_itensorlike.DynIndex::new_bondvsnew_dynasymmetry (one returns Result, the other doesn't) unexplained.- Relationship between
CanonicalFormandTruncateAlgundocumented —truncate()implicitly sets canonical form based on algorithm.
Missing "Getting Started" content
- Add a complete import list example including
tensor4all_core::{DynIndex, TensorDynLen, TensorLike, AnyScalar}. - Show inner product workflow in README example.
Found by
Automated feature test (test-feature-20260327-itensorlike)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels