Skip to content

Commit 2cc4407

Browse files
committed
Edits to *List classes for reference
1 parent 70309a0 commit 2cc4407

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

core/src/processing/data/FloatList.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ public int index(float what) {
391391

392392
/**
393393
* @webref floatlist:method
394-
* @brief To come...
394+
* @brief Check if a number is a part of the list
395395
*/
396396
public boolean hasValue(float value) {
397397
if (Float.isNaN(value)) {
@@ -418,39 +418,39 @@ public boolean hasValue(float value) {
418418

419419
/**
420420
* @webref floatlist:method
421-
* @brief To come...
421+
* @brief Add to a value
422422
*/
423423
public void add(int index, float amount) {
424424
data[index] += amount;
425425
}
426426

427427
/**
428428
* @webref floatlist:method
429-
* @brief To come...
429+
* @brief Subtract from a value
430430
*/
431431
public void sub(int index, float amount) {
432432
data[index] -= amount;
433433
}
434434

435435
/**
436436
* @webref floatlist:method
437-
* @brief To come...
437+
* @brief Multiply a value
438438
*/
439439
public void mult(int index, float amount) {
440440
data[index] *= amount;
441441
}
442442

443443
/**
444444
* @webref floatlist:method
445-
* @brief To come...
445+
* @brief Divide a value
446446
*/
447447
public void div(int index, float amount) {
448448
data[index] /= amount;
449449
}
450450

451451
/**
452452
* @webref floatlist:method
453-
* @brief To come...
453+
* @brief Return the smallest value
454454
*/
455455
public float min() {
456456
if (count == 0) {
@@ -480,7 +480,7 @@ public float min() {
480480

481481
/**
482482
* @webref floatlist:method
483-
* @brief To come...
483+
* @brief Return the largest value
484484
*/
485485
public float max() {
486486
if (count == 0) {
@@ -513,7 +513,7 @@ public float max() {
513513
* Sorts the array in place.
514514
*
515515
* @webref floatlist:method
516-
* @brief Sorts an array in place
516+
* @brief Sorts an array, lowest to highest
517517
*/
518518
public void sort() {
519519
Arrays.sort(data, 0, count);
@@ -524,7 +524,7 @@ public void sort() {
524524
* Reverse sort, orders values from highest to lowest
525525
*
526526
* @webref floatlist:method
527-
* @brief To come...
527+
* @brief Reverse sort, orders values from highest to lowest
528528
*/
529529
public void sortReverse() {
530530
new Sort() {
@@ -567,7 +567,7 @@ public void subset(int start, int num) {
567567

568568
/**
569569
* @webref floatlist:method
570-
* @brief To come...
570+
* @brief Reverse sort, orders values by first digit
571571
*/
572572
public void reverse() {
573573
int ii = count - 1;

core/src/processing/data/IntList.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ public int index(int what) {
338338

339339
/**
340340
* @webref floatlist:method
341-
* @brief To come...
341+
* @brief Check if a number is a part of the data structure
342342
*/
343343
public boolean hasValue(int value) {
344344
// if (indexCache == null) {
@@ -355,47 +355,47 @@ public boolean hasValue(int value) {
355355

356356
/**
357357
* @webref floatlist:method
358-
* @brief To come...
358+
* @brief Add one to a value
359359
*/
360360
public void increment(int index) {
361361
data[index]++;
362362
}
363363

364364
/**
365365
* @webref floatlist:method
366-
* @brief To come...
366+
* @brief Add to a value
367367
*/
368368
public void add(int index, int amount) {
369369
data[index] += amount;
370370
}
371371

372372
/**
373373
* @webref floatlist:method
374-
* @brief To come...
374+
* @brief Subtract from a value
375375
*/
376376
public void sub(int index, int amount) {
377377
data[index] -= amount;
378378
}
379379

380380
/**
381381
* @webref floatlist:method
382-
* @brief To come...
382+
* @brief Multiply a value
383383
*/
384384
public void mult(int index, int amount) {
385385
data[index] *= amount;
386386
}
387387

388388
/**
389389
* @webref floatlist:method
390-
* @brief To come...
390+
* @brief Divide a value
391391
*/
392392
public void div(int index, int amount) {
393393
data[index] /= amount;
394394
}
395395

396396
/**
397397
* @webref floatlist:method
398-
* @brief To come...
398+
* @brief Return the smallest value
399399
*/
400400
public int min() {
401401
if (count == 0) {
@@ -410,7 +410,7 @@ public int min() {
410410

411411
/**
412412
* @webref floatlist:method
413-
* @brief To come...
413+
* @brief Return the largest value
414414
*/
415415
public int max() {
416416
if (count == 0) {
@@ -428,7 +428,7 @@ public int max() {
428428
* Sorts the array in place.
429429
*
430430
* @webref floatlist:method
431-
* @brief Sorts the array in place
431+
* @brief Sorts the array, lowest to highest
432432
*/
433433
public void sort() {
434434
Arrays.sort(data, 0, count);
@@ -482,7 +482,7 @@ public void swap(int a, int b) {
482482

483483
/**
484484
* @webref floatlist:method
485-
* @brief To come...
485+
* @brief Reverse sort, orders values by first digit
486486
*/
487487
public void reverse() {
488488
int ii = count - 1;

core/src/processing/data/StringList.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ public int index(String what) {
387387

388388
/**
389389
* @webref stringlist:method
390-
* @brief To come...
390+
* @brief Check if a value is a part of the list
391391
*/
392392
public boolean hasValue(String value) {
393393
if (value == null) {

0 commit comments

Comments
 (0)