JSUS/docs/lib/array.js.html at tmp · nodeGame/JSUS

History

1538 lines (1442 loc) · 98.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<html>

<head>

<title>array.js</title>

var relativeDir = '../', thisFile = 'lib/array.js', defaultSidebar = true;

</script>

</head>

<body>

Files

Headings

</div>

<a href="#array">ARRAY</a>

</div>

<a href="#array.filter">ARRAY.filter</a>

</div>

<a href="#array.isarray">ARRAY.isArray</a>

</div>

<a href="#array.seq">ARRAY.seq</a>

</div>

<a href="#array.each">ARRAY.each</a>

</div>

<a href="#array.map">ARRAY.map</a>

</div>

<a href="#array.removeelement">ARRAY.removeElement</a>

</div>

<a href="#array.inarray">ARRAY.inArray</a>

</div>

<a href="#array.getngroups">ARRAY.getNGroups</a>

</div>

<a href="#array.getgroupssizen">ARRAY.getGroupsSizeN</a>

</div>

<a href="#array._latinsquare">ARRAY._latinSquare</a>

</div>

<a href="#array.latinsquare">ARRAY.latinSquare</a>

</div>

<a href="#array.latinsquarenoself">ARRAY.latinSquareNoSelf</a>

</div>

<a href="#array.generatecombinations">ARRAY.generateCombinations</a>

</div>

<a href="#array.matchn">ARRAY.matchN</a>

</div>

<a href="#array.rep">ARRAY.rep</a>

</div>

<a href="#array.stretch">ARRAY.stretch</a>

</div>

<a href="#array.arrayintersect">ARRAY.arrayIntersect</a>

</div>

<a href="#array.arraydiff">ARRAY.arrayDiff</a>

</div>

<a href="#array.shuffle">ARRAY.shuffle</a>

</div>

<a href="#array.getnrandom">ARRAY.getNRandom</a>

</div>

<a href="#array.distinct">ARRAY.distinct</a>

</div>

<a href="#array.transpose">ARRAY.transpose</a>

</div>

<tbody>

<tr>

<h1>

ARRAY

</h1>

</div>

MIT Licensed

</div>

<div class="body">Collection of static functions to manipulate arrays

</div>

</td>

<td class="code highlight"><div class="highlight"><pre>(function(JSUS) {

"use strict";

function ARRAY() {}</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.filter

</h2>

</div>

<div class="body">Add the filter method to ARRAY objects in case the method is not

supported natively.

</div>

<a href=" Global_Objects/ARRAY/filter

">https://developer.mozilla.org/en/JavaScript/Reference/

</a>

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> if (!Array.prototype.filter) {

Array.prototype.filter = function(fun /*, thisp */) {

if (this === void 0 || this === null) throw new TypeError();

var t = new Object(this);

var len = t.length >>> 0;

if (typeof fun !== "function") throw new TypeError();

var res = [];

var thisp = arguments[1];

for (var i = 0; i < len; i++) {

if (i in t) {

var val = t[i]; // in case fun mutates this

if (fun.call(thisp, val, i, t)) {

res.push(val);

}

return res;

};

}</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.isArray

</h2>

</div>

<div class="body">Returns TRUE if a variable is an Array

This method is exactly the same as <code>Array.isArray</code>,

but it works on a larger share of browsers.

</div>

<div class="dox_tag_title">Params</div>

o

object

The variable to check.

</div>

Array.isArray

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.isArray = (function(f) {

if ('function' === typeof f) return f;

else return function(o) {

if (!o) return false;

return Object.prototype.toString.call(o) === '[object Array]';

};

})(Array.isArray);</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.seq

</h2>

</div>

<div class="body">Returns an array of sequential numbers from start to end

If start > end the series goes backward.

The distance between two subsequent numbers can be controlled

by the increment parameter.

When increment is not a divider of Abs(start - end), end will

be missing from the series.

A callback function to apply to each element of the sequence

can be passed as fourth parameter.

Returns FALSE, in case parameters are incorrectly specified

</div>

<div class="dox_tag_title">Params</div>

start

number

The first element of the sequence

</div>

end

number

The last element of the sequence

</div>

increment

number

Optional. The increment between two

subsequents element of the sequence

</div>

func

Function

Optional. A callback function that can modify

each number of the sequence before returning it

</div>

<div class="dox_tag_title">Returns</div>

array

The final sequence

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.seq = function(start, end, increment, func) {

var i, out;

if ('number' !== typeof start) return false;

if (start === Infinity) return false;

if ('number' !== typeof end) return false;

if (end === Infinity) return false;

if (start === end) return [start];

if (increment === 0) return false;

if (!JSUS.inArray(typeof increment, ['undefined', 'number'])) {

return false;

}

increment = increment || 1;

func = func || function(e) {return e;};

i = start;

out = [];

if (start < end) {

while (i <= end) {

out.push(func(i));

i = i + increment;

}

else {

while (i >= end) {

i = i - increment;

}

return out;

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.each

</h2>

</div>

<div class="body">Executes a callback on each element of the array

If an error occurs returns FALSE.

</div>

<div class="dox_tag_title">Params</div>

array

array

The array to loop in

</div>

func

Function

The callback for each element in the array

</div>

context

object

Optional. The context of execution of the

callback. Defaults ARRAY.each

</div>

<div class="dox_tag_title">Returns</div>

boolean

TRUE, if execution was successful

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.each = function(array, func, context) {

if ('object' !== typeof array) return false;

if (!func) return false;

context = context || this;

var i, len = array.length;

for (i = 0 ; i < len; i++) {

func.call(context, array[i]);

}

return true;

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.map

</h2>

</div>

<div class="body">Executes a callback to each element of the array and returns the result

Any number of additional parameters can be passed after the

callback function.

</div>

<div class="dox_tag_title">Returns</div>

array

The result of the mapping execution

</div>

ARRAY.each

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.map = function() {

var i, len, args, out, o;

var array, func;

array = arguments[0];

func = arguments[1];

if (!ARRAY.isArray(array)) {

JSUS.log('ARRAY.map: first parameter must be array. Found: ' +

array);

return;

}

if ('function' !== typeof func) {

JSUS.log('ARRAY.map: second parameter must be function. Found: ' +

func);

return;

}

len = arguments.length;

if (len === 3) args = [null, arguments[2]];

else if (len === 4) args = [null, arguments[2], arguments[3]];

else {

len = len - 1;

args = new Array(len);

for (i = 1; i < (len); i++) {

args[i] = arguments[i+1];

}

out = [], len = array.length;

for (i = 0; i < len; i++) {

args[0] = array[i];

o = func.apply(this, args);

if ('undefined' !== typeof o) out.push(o);

}

return out;

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.removeElement

</h2>

</div>

<div class="body">Removes an element from the the array, and returns it

For objects, deep equality comparison is performed

through JSUS.equals.

If no element is removed returns FALSE.

</div>

<div class="dox_tag_title">Params</div>

needle

mixed

The element to search in the array

</div>

haystack

array

The array to search in

</div>

<div class="dox_tag_title">Returns</div>

mixed

The element that was removed, FALSE if none was removed

</div>

JSUS.equals

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.removeElement = function(needle, haystack) {

var func, i;

if ('undefined' === typeof needle || !haystack) return false;

if ('object' === typeof needle) {

func = JSUS.equals;

}

else {

func = function(a, b) {

return (a === b);

};

}

for (i = 0; i < haystack.length; i++) {

if (func(needle, haystack[i])){

return haystack.splice(i,1);

}

return false;

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.inArray

</h2>

</div>

<div class="body">Returns TRUE if the element is contained in the array,

FALSE otherwise

For objects, deep equality comparison is performed

through JSUS.equals.

</div>

<div class="dox_tag_title">Params</div>

needle

mixed

The element to search in the array

</div>

haystack

array

The array to search in

</div>

<div class="dox_tag_title">Returns</div>

boolean

TRUE, if the element is contained in the array

</div>

JSUS.equals

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.inArray = function(needle, haystack) {

var func, i, len;

if (!haystack) return false;

func = JSUS.equals;

len = haystack.length;

for (i = 0; i < len; i++) {

if (func.call(this, needle, haystack[i])) {

return true;

}

return false;

};

ARRAY.in_array = function(needle, haystack) {

console.log('***ARRAY.in_array is deprecated. ' +

'Use ARRAY.inArray instead.***');

return ARRAY.inArray(needle, haystack);

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.getNGroups

</h2>

</div>

<div class="body">Returns an array of N array containing the same number of elements

If the length of the array and the desired number of elements per group

are not multiple, the last group could have less elements

The original array is not modified.

@see ARRAY.getGroupsSizeN

@see ARRAY.generateCombinations

@see ARRAY.matchN

</div>

<div class="dox_tag_title">Params</div>

array

array

The array to split in subgroups

</div>

N

number

The number of subgroups

</div>

<div class="dox_tag_title">Returns</div>

array

Array containing N groups

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.getNGroups = function(array, N) {

return ARRAY.getGroupsSizeN(array, Math.floor(array.length / N));

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.getGroupsSizeN

</h2>

</div>

<div class="body">Returns an array of arrays containing N elements each

The last group could have less elements

</div>

<div class="dox_tag_title">Params</div>

array

array

The array to split in subgroups

</div>

N

number

The number of elements in each subgroup

</div>

<div class="dox_tag_title">Returns</div>

array

Array containing groups of size N

</div>

ARRAY.getNGroups

</div>

ARRAY.generateCombinations

</div>

ARRAY.matchN

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.getGroupsSizeN = function(array, N) {

var copy = array.slice(0);

var len = copy.length;

var originalLen = copy.length;

var result = [];</pre></div>

</td>

</tr>

<tr>

</div>

Init values for the loop algorithm.

</td>

<td class="code highlight"><div class="highlight"><pre> var i, idx;

var group = [], count = 0;

for (i=0; i < originalLen; i++) {</pre></div>

</td>

</tr>

<tr>

</div>

Get a random idx between 0 and array length.

</td>

<td class="code highlight"><div class="highlight"><pre> idx = Math.floor(Math.random()*len);</pre></div>

</td>

</tr>

<tr>

</div>

Prepare the array container for the elements of a new group.

</td>

<td class="code highlight"><div class="highlight"><pre> if (count >= N) {

result.push(group);

count = 0;

group = [];

}</pre></div>

</td>

</tr>

<tr>

</div>

Insert element in the group.

</td>

<td class="code highlight"><div class="highlight"><pre> group.push(copy[idx]);</pre></div>

</td>

</tr>

<tr>

</div>

Update.

</td>

<td class="code highlight"><div class="highlight"><pre> copy.splice(idx,1);

len = copy.length;

count++;

}</pre></div>

</td>

</tr>

<tr>

</div>

Add any remaining element.

</td>

<td class="code highlight"><div class="highlight"><pre> if (group.length > 0) {

result.push(group);

}

return result;

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY._latinSquare

</h2>

</div>

<div class="body">Generate a random Latin Square of size S

If N is defined, it returns "Latin Rectangle" (SxN)

A parameter controls for self-match, i.e. whether the symbol "i"

is found or not in in column "i".

</div>

private

<div class="dox_tag_title">Params</div>

S

number

The number of rows

</div>

Optional.

number

N The number of columns. Defaults N = S

</div>

Optional.

boolean

If TRUE self-match is allowed. Defaults TRUE

</div>

<div class="dox_tag_title">Returns</div>

array

The resulting latin square (or rectangle)

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY._latinSquare = function(S, N, self) {

self = ('undefined' === typeof self) ? true : self;</pre></div>

</td>

</tr>

<tr>

</div>

Infinite loop.

</td>

<td class="code highlight"><div class="highlight"><pre> if (S === N && !self) return false;

var seq = [];

var latin = [];

for (var i=0; i< S; i++) {

seq[i] = i;

}

var idx = null;

var start = 0;

var limit = S;

var extracted = [];

if (!self) {

limit = S-1;

}

for (i=0; i < N; i++) {

do {

idx = JSUS.randomInt(start,limit);

}

while (JSUS.inArray(idx, extracted));

extracted.push(idx);

if (idx == 1) {

latin[i].push(0);

}

else {

latin[i] = seq.slice(idx).concat(seq.slice(0,(idx)));

}

return latin;

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.latinSquare

</h2>

</div>

<div class="body">Generate a random Latin Square of size S

If N is defined, it returns "Latin Rectangle" (SxN)

</div>

<div class="dox_tag_title">Params</div>

S

number

The number of rows

</div>

Optional.

number

N The number of columns. Defaults N = S

</div>

<div class="dox_tag_title">Returns</div>

array

The resulting latin square (or rectangle)

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.latinSquare = function(S, N) {

if (!N) N = S;

if (!S || S < 0 || (N < 0)) return false;

if (N > S) N = S;

return ARRAY._latinSquare(S, N, true);

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.latinSquareNoSelf

</h2>

</div>

<div class="body">Generate a random Latin Square of size Sx(S-1), where

in each column "i", the symbol "i" is not found

If N < S, it returns a "Latin Rectangle" (SxN)

</div>

<div class="dox_tag_title">Params</div>

S

number

The number of rows

</div>

Optional.

number

N The number of columns. Defaults N = S-1

</div>

<div class="dox_tag_title">Returns</div>

array

The resulting latin square (or rectangle)

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.latinSquareNoSelf = function(S, N) {

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.generateCombinations

</h2>

</div>

<div class="body">Generates all distinct combinations of exactly r elements each

</div>

<div class="dox_tag_title">Params</div>

array

array

The array from which the combinations are extracted

</div>

r

number

The number of elements in each combination

</div>

<div class="dox_tag_title">Returns</div>

array

The total sets of combinations

</div>

ARRAY.getGroupSizeN

</div>

ARRAY.getNGroups

</div>

<a href="http://rosettacode.org/wiki/Combinations#JavaScript

">ARRAY.matchN

Kudos:</a>

</div>

</td>

<td class="code highlight"><div class="highlight"><pre> ARRAY.generateCombinations = function combinations(arr, k) {

var i, subI, ret, sub, next;

ret = [];

for (i = 0; i < arr.length; i++) {

if (k === 1) {

ret.push( [ arr[i] ] );

}

else {

sub = combinations(arr.slice(i+1, arr.length), k-1);

for (subI = 0; subI < sub.length; subI++ ){

next = sub[subI];

next.unshift(arr[i]);

ret.push( next );

}

return ret;

};</pre></div>

</td>

</tr>

<tr>

<h2>

ARRAY.matchN

</h2>

</div>

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

array.js.html

Latest commit

History

array.js.html

File metadata and controls