@@ -91,6 +91,102 @@ Use `vector_ip_ops` for inner product and `vector_cosine_ops` for cosine distanc
9191
9292See a [ full example] ( test/postgres_test.dart )
9393
94+ ## Reference
95+
96+ ### Vectors
97+
98+ Create a vector from a list
99+
100+ ``` dart
101+ var vec = Vector([1, 2, 3]);
102+ ```
103+
104+ Get a list
105+
106+ ``` dart
107+ var list = vec.toList();
108+ ```
109+
110+ ### Half Vectors
111+
112+ Create a half vector from a list
113+
114+ ``` dart
115+ var vec = HalfVector([1, 2, 3]);
116+ ```
117+
118+ Get a list
119+
120+ ``` dart
121+ var list = vec.toList();
122+ ```
123+
124+ ### Binary Vectors
125+
126+ Create a binary vector from a list
127+
128+ ``` dart
129+ var vec = Bit([true, false, true])
130+ ```
131+
132+ Or a string
133+
134+ ``` dart
135+ var vec = Bit("101")
136+ ```
137+
138+ Get a list
139+
140+ ``` dart
141+ var list = vec.toList();
142+ ```
143+
144+ Get a string
145+
146+ ``` dart
147+ var str = vec.toString();
148+ ```
149+
150+ ### Sparse Vectors
151+
152+ Create a sparse vector from a list
153+
154+ ``` dart
155+ var vec = SparseVector([1, 0, 2, 0, 3, 0]);
156+ ```
157+
158+ Or a map of non-zero elements
159+
160+ ``` dart
161+ var vec = SparseVector.fromMap({0: 1.0, 2: 2.0, 4: 3.0}, 6);
162+ ```
163+
164+ Note: Indices start at 0
165+
166+ Get the number of dimensions
167+
168+ ``` dart
169+ var dim = vec.dimensions;
170+ ```
171+
172+ Get the indices of non-zero elements
173+
174+ ``` dart
175+ var indices = vec.indices;
176+ ```
177+
178+ Get the values of non-zero elements
179+
180+ ``` dart
181+ var values = vec.values;
182+ ```
183+
184+ Get a list
185+
186+ ``` dart
187+ var list = vec.toList();
188+ ```
189+
94190## History
95191
96192View the [ changelog] ( https://github.com/pgvector/pgvector-dart/blob/master/CHANGELOG.md )
0 commit comments