Skip to content

Commit 0278f25

Browse files
committed
Cursors docs
1 parent 57546a4 commit 0278f25

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

convex-core/src/main/java/convex/lattice/Cursors.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,22 @@
55

66
public class Cursors {
77

8+
/**
9+
* Create a root cursor with the given value
10+
* @param <V> Type of cursor value
11+
* @param a Any object to be converted to CVM type
12+
* @return New cursor instance
13+
*/
814
public static <V extends ACell> Root<V> of(Object a) {
915
return create(RT.cvm(a));
1016
}
1117

18+
/**
19+
* Create a root cursor with the given value
20+
* @param <V> Type of cursor value
21+
* @param a Any compatible CVM value
22+
* @return New cursor instance
23+
*/
1224
private static <V extends ACell> Root<V> create(V value) {
1325
return Root.create(value);
1426
}

0 commit comments

Comments
 (0)