Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

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

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

1104

1105

1106

1107

1108

1109

1110

1111

1112

1113

1114

1115

1116

1117

1118

1119

1120

1121

1122

1123

1124

1125

1126

1127

1128

1129

1130

1131

1132

1133

1134

1135

1136

1137

1138

1139

1140

1141

1142

1143

1144

1145

1146

1147

1148

1149

1150

1151

1152

1153

1154

1155

1156

1157

1158

1159

1160

1161

1162

1163

1164

1165

1166

1167

1168

1169

1170

1171

1172

1173

1174

1175

1176

1177

1178

1179

1180

1181

1182

1183

1184

1185

1186

1187

1188

1189

1190

1191

1192

1193

1194

1195

1196

1197

1198

1199

1200

1201

1202

1203

1204

1205

1206

1207

1208

1209

1210

1211

1212

1213

1214

1215

1216

1217

1218

1219

1220

1221

1222

1223

1224

1225

1226

1227

1228

1229

1230

1231

1232

1233

1234

1235

1236

1237

1238

1239

1240

1241

1242

1243

1244

1245

1246

1247

1248

1249

1250

1251

1252

1253

1254

1255

1256

1257

1258

1259

1260

1261

1262

1263

1264

1265

1266

1267

1268

1269

1270

1271

1272

1273

1274

1275

1276

1277

1278

1279

1280

1281

1282

1283

1284

1285

1286

1287

1288

1289

1290

1291

1292

1293

1294

1295

1296

1297

1298

1299

1300

1301

1302

1303

1304

1305

1306

1307

1308

1309

1310

1311

1312

1313

1314

1315

1316

1317

1318

1319

1320

1321

1322

1323

1324

1325

1326

1327

1328

1329

1330

1331

1332

1333

1334

1335

1336

1337

1338

1339

1340

1341

1342

1343

1344

1345

1346

1347

1348

1349

1350

1351

1352

1353

1354

1355

1356

1357

1358

1359

1360

1361

1362

1363

1364

1365

1366

1367

1368

1369

1370

1371

1372

1373

1374

1375

1376

1377

1378

1379

1380

1381

1382

1383

1384

1385

1386

1387

1388

1389

1390

1391

1392

1393

1394

1395

1396

1397

1398

1399

1400

1401

1402

1403

1404

1405

1406

1407

1408

1409

1410

1411

1412

1413

1414

1415

1416

1417

1418

1419

1420

1421

1422

1423

1424

1425

1426

1427

1428

1429

1430

1431

1432

1433

1434

1435

1436

1437

1438

1439

1440

1441

1442

1443

1444

1445

1446

1447

1448

1449

1450

1451

1452

1453

1454

1455

1456

1457

1458

1459

1460

1461

1462

1463

1464

1465

1466

1467

1468

1469

1470

1471

1472

1473

1474

1475

1476

1477

1478

1479

1480

1481

1482

1483

1484

1485

1486

1487

1488

1489

1490

1491

1492

1493

1494

1495

1496

1497

1498

1499

1500

1501

1502

1503

1504

1505

1506

1507

1508

1509

1510

1511

1512

1513

1514

1515

1516

1517

1518

1519

1520

1521

1522

1523

1524

1525

1526

1527

1528

1529

1530

1531

1532

1533

1534

1535

1536

1537

1538

1539

1540

1541

1542

1543

1544

1545

1546

1547

1548

1549

1550

1551

1552

1553

1554

1555

1556

1557

1558

1559

1560

1561

1562

1563

1564

1565

1566

1567

1568

1569

1570

1571

1572

1573

1574

1575

1576

1577

1578

1579

1580

1581

1582

1583

1584

1585

1586

1587

1588

1589

1590

1591

1592

1593

1594

1595

1596

1597

1598

1599

1600

1601

1602

1603

1604

1605

1606

1607

1608

1609

1610

1611

1612

1613

1614

1615

1616

1617

1618

1619

1620

1621

1622

1623

1624

1625

1626

1627

1628

1629

1630

1631

1632

1633

1634

1635

1636

1637

1638

1639

1640

1641

1642

1643

1644

1645

1646

1647

1648

1649

1650

1651

1652

1653

1654

1655

1656

1657

1658

1659

1660

1661

1662

1663

1664

1665

1666

1667

1668

1669

1670

1671

1672

1673

1674

1675

1676

r""" 

Abstract word (finite or infinite) 

 

This module gathers functions that works for both finite and infinite 

words. 

 

AUTHORS: 

 

- Sebastien Labbe 

- Franco Saliola 

 

EXAMPLES:: 

 

sage: a = 0.618 

sage: g = words.CodingOfRotationWord(alpha=a, beta=1-a, x=a) 

sage: f = words.FibonacciWord() 

sage: p = f.longest_common_prefix(g, length='finite') 

sage: p 

word: 0100101001001010010100100101001001010010... 

sage: p.length() 

231 

""" 

#***************************************************************************** 

# Copyright (C) 2008-2010 Sebastien Labbe <slabqc@gmail.com>, 

# 2008-2010 Franco Saliola <saliola@gmail.com> 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 2 of the License, or 

# (at your option) any later version. 

# http://www.gnu.org/licenses/ 

#***************************************************************************** 

from __future__ import print_function 

from six.moves import range 

 

from builtins import zip 

 

from sage.structure.sage_object import SageObject 

from sage.combinat.words.word_options import word_options 

from itertools import islice, groupby 

from sage.rings.all import Integers, ZZ, Infinity 

from sage.structure.richcmp import (richcmp_method, rich_to_bool, 

richcmp, op_LT, op_GT) 

 

 

@richcmp_method 

class Word_class(SageObject): 

def parent(self): 

r""" 

Returns the parent of self. 

 

TESTS:: 

 

sage: Word(iter([1,2,3]), length="unknown").parent() 

Finite words over Set of Python objects of class 'object' 

sage: Word(range(12)).parent() 

Finite words over Set of Python objects of class 'object' 

sage: Word(range(4), alphabet=list(range(6))).parent() 

Finite words over {0, 1, 2, 3, 4, 5} 

sage: Word(iter('abac'), alphabet='abc').parent() 

Finite words over {'a', 'b', 'c'} 

""" 

return self._parent 

 

def _repr_(self): 

r""" 

Returns a string representation of self. 

 

TESTS:: 

 

sage: Word(iter([1,2,3]), length="unknown")._repr_() 

'word: 123' 

sage: Word(range(100), length="unknown")._repr_() 

'word: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,...' 

sage: Word(lambda x:x%3)._repr_() 

'word: 0120120120120120120120120120120120120120...' 

""" 

global word_options 

if word_options['old_repr']: 

return "Word over %s" % (str(self.parent().alphabet())[17:]) 

return word_options['identifier'] + self.string_rep() 

 

def string_rep(self): 

r""" 

Returns the (truncated) raw sequence of letters as a string. 

 

EXAMPLES:: 

 

sage: Word('abbabaab').string_rep() 

'abbabaab' 

sage: Word([0, 1, 0, 0, 1]).string_rep() 

'01001' 

sage: Word([0,1,10,101]).string_rep() 

'0,1,10,101' 

sage: WordOptions(letter_separator='-') 

sage: Word([0,1,10,101]).string_rep() 

'0-1-10-101' 

sage: WordOptions(letter_separator=',') 

 

TESTS: 

 

Insertion in a str:: 

 

sage: from itertools import count 

sage: w = Word((i % 5 for i in count()), length='unknown') 

sage: "w = %s in this string." % w 

'w = 0123401234012340123401234012340123401234... in this string.' 

 

Using LatexExpr:: 

 

sage: from sage.misc.latex import LatexExpr 

sage: LatexExpr(w) 

0123401234012340123401234012340123401234... 

 

With the print statement:: 

 

sage: print(w) 

0123401234012340123401234012340123401234... 

 

Truncation is done for possibly infinite words:: 

 

sage: print(w) 

0123401234012340123401234012340123401234... 

""" 

global word_options 

l = word_options['truncate_length'] 

letters = list(islice(self, l+1)) 

if len(letters) == l+1: 

letters.pop() 

suffix = "..." 

else: 

suffix = "" 

if word_options['display'] == 'string': 

ls = word_options['letter_separator'] 

letters = [str(_) for _ in letters] 

if all(len(a)==1 for a in letters): 

return ''.join(letters) + suffix 

elif suffix == "...": 

return ls.join(letters) + ls + suffix 

else: 

return ls.join(letters) 

elif word_options['display'] == 'list': 

if suffix == "...": 

return "[%s, %s]" % (str(letters)[1:-1], suffix) 

else: 

return str(letters) 

 

__str__ = string_rep 

 

def __iter__(self): 

r""" 

EXAMPLES:: 

 

sage: from sage.combinat.words.word import Word_class 

sage: w = Word_class() 

sage: w.__iter__() 

Traceback (most recent call last): 

... 

NotImplementedError: you need to define an iterator in __iter__ 

""" 

raise NotImplementedError("you need to define an iterator in __iter__") 

 

def length(self): 

r""" 

Returns the length of self. 

 

TESTS:: 

 

sage: from sage.combinat.words.word import Word_class 

sage: w = Word(iter('abba'*100), length="unknown") 

sage: w.length() is None 

True 

sage: w = Word(iter('abba'), length="finite") 

sage: w.length() 

4 

sage: w = Word(iter([0,1,1,0,1,0,0,1]*100), length="unknown") 

sage: w.length() is None 

True 

sage: w = Word(iter([0,1,1,0,1,0,0,1]), length="finite") 

sage: w.length() 

8 

""" 

return self._len 

 

def is_finite(self): 

r""" 

Returns whether this word is known to be finite. 

 

.. WARNING:: 

 

A word defined by an iterator such that its end has 

never been reached will returns False. 

 

EXAMPLES:: 

 

sage: Word([]).is_finite() 

True 

sage: Word('a').is_finite() 

True 

sage: TM = words.ThueMorseWord() 

sage: TM.is_finite() 

False 

 

:: 

 

sage: w = Word(iter('a'*100)) 

sage: w.is_finite() 

False 

 

""" 

return False 

 

def __len__(self): 

r""" 

Return the length of self (as a python integer). 

 

.. NOTE:: 

 

For infinite words or words of unknown length, 

use `length()` method instead. 

 

OUTPUT: 

 

positive integer 

 

EXAMPLES:: 

 

sage: len(Word(lambda n:n, length=1000)) 

1000 

sage: len(Word(iter('a'*200), length='finite')) 

200 

 

We make sure :trac:`8574` is fixed:: 

 

sage: s = WordMorphism('0->000,1->%s'%('1'*100)) 

sage: len(s('1')) 

100 

 

For infinite words:: 

 

sage: len(Word(lambda n:n)) 

Traceback (most recent call last): 

... 

TypeError: Python len method can not return a non integer value (=+Infinity): use length method instead. 

sage: len(Word(iter('a'*200))) 

Traceback (most recent call last): 

... 

TypeError: Python len method can not return a non integer value (=None): use length method instead. 

 

For words of unknown length:: 

 

sage: len(Word(iter('a'*200), length='unknown')) 

Traceback (most recent call last): 

... 

TypeError: Python len method can not return a non integer value (=None): use length method instead. 

""" 

L = self.length() 

if L is None or L is Infinity: 

msg = "Python len method can not return a non integer value (=%s): "%L 

msg += "use length method instead." 

raise TypeError(msg) 

return int(L) 

 

def __richcmp__(self, other, op): 

r""" 

Compare two words lexicographically according to the ordering 

defined by the parent of ``self``. 

 

This corresponds to Python's built-in 

ordering when no parent nor alphabet was used to defined the word. 

 

Provides for all normal comparison operators. 

 

.. NOTE:: 

 

This function will not terminate if ``self`` and ``other`` 

are equal infinite words! 

 

EXAMPLES:: 

 

sage: W = Word 

sage: from itertools import count 

sage: W(range(1,10)) > W(range(10)) 

True 

sage: W(range(10)) < W(range(1,10)) 

True 

sage: W(range(10)) == W(range(10)) 

True 

sage: W(range(10)) < W(count()) 

True 

sage: W(count()) > W(range(10)) 

True 

 

:: 

 

sage: W = Words(['a', 'b', 'c']) 

sage: W('a') > W([]) 

True 

sage: W([]) < W('a') 

True 

 

sage: Word('abc') == Word(['a','b','c']) 

True 

sage: Words([0,1])([0,1,0,1]) == Words([0,1])([0,1,0,1]) 

True 

sage: Words([0,1])([0,1,0,1]) == Words([0,1])([0,1,0,0]) 

False 

 

It works even when parents are not the same:: 

 

sage: Words([0,1,2])([0,1,0,1]) == Words([0,1])([0,1,0,1]) 

True 

sage: Words('abc')('abab') == Words([0,9])([0,0,9]) 

False 

sage: Word('ababa') == Words('abcd')('ababa') 

True 

 

Or when one word is finite while the other is infinite:: 

 

sage: Word(range(20)) == Word(lambda n:n) 

False 

sage: Word(lambda n:n) == Word(range(20)) 

False 

 

Beware the following does not halt! :: 

 

sage: from itertools import count 

sage: Word(lambda n:n) == Word(count()) #not tested 

 

Examples for unequality:: 

 

sage: w = Word(range(10)) 

sage: z = Word(range(10)) 

sage: w != z 

False 

sage: u = Word(range(12)) 

sage: u != w 

True 

 

TESTS:: 

 

sage: Word(count())[:20] == Word(range(20)) 

True 

sage: Word(range(20)) == Word(count())[:20] 

True 

sage: Word(range(20)) == Word(lambda n:n)[:20] 

True 

sage: Word(range(20)) == Word(lambda n:n,length=20) 

True 

""" 

if not isinstance(other, Word_class): 

return NotImplemented 

self_it, other_it = iter(self), iter(other) 

cmp_key = self._parent.sortkey_letters 

while True: 

try: 

cs = next(self_it) 

except StopIteration: 

try: 

co = next(other_it) 

except StopIteration: 

# If both self_it and other_it are exhausted then 

# self == other. Return 0. 

return rich_to_bool(op, 0) 

else: 

# If self_it is exhausted, but not other_it, then 

# self is a proper prefix of other: return -1 

return rich_to_bool(op, -1) 

else: 

try: 

co = next(other_it) 

except StopIteration: 

# If self_it is not exhausted but other_it is, then 

# other is a proper prefix of self: return 1. 

return rich_to_bool(op, 1) 

else: 

key_cs = cmp_key(cs) 

key_co = cmp_key(co) 

if key_cs < key_co: 

return rich_to_bool(op, -1) 

elif key_cs > key_co: 

return rich_to_bool(op, 1) 

 

def _longest_common_prefix_iterator(self, other): 

r""" 

Return an iterator of the longest common prefix of self and other. 

 

INPUT: 

 

- ``other`` - word 

 

OUTPUT: 

 

iterator 

 

EXAMPLES:: 

 

sage: f = words.FibonacciWord() 

sage: it = f._longest_common_prefix_iterator(f) 

sage: w = Word(it, length="unknown"); w 

word: 0100101001001010010100100101001001010010... 

sage: w[:6] 

word: 010010 

sage: it = w._longest_common_prefix_iterator(w[:10]) 

sage: w = Word(it, length="finite"); w 

word: 0100101001 

""" 

for (b, c) in zip(self, other): 

if b == c: 

yield b 

else: 

break 

 

def longest_common_prefix(self, other, length='unknown'): 

r""" 

Returns the longest common prefix of self and other. 

 

INPUT: 

 

- ``other`` - word 

 

- ``length`` - string (optional, default: ``'unknown'``) 

the length type of the resulting word if known. It may be one of 

the following: 

 

- ``'unknown'`` 

- ``'finite'`` 

- ``'infinite'`` 

 

EXAMPLES:: 

 

sage: f = lambda n : add(Integer(n).digits(2)) % 2 

sage: t = Word(f) 

sage: u = t[:10] 

sage: t.longest_common_prefix(u) 

word: 0110100110 

 

The longest common prefix of two equal infinite words:: 

 

sage: t1 = Word(f) 

sage: t2 = Word(f) 

sage: t1.longest_common_prefix(t2) 

word: 0110100110010110100101100110100110010110... 

 

Useful to study the approximation of an infinite word:: 

 

sage: a = 0.618 

sage: g = words.CodingOfRotationWord(alpha=a, beta=1-a, x=a) 

sage: f = words.FibonacciWord() 

sage: p = f.longest_common_prefix(g, length='finite') 

sage: p.length() 

231 

 

TESTS:: 

 

sage: w = Word('12345') 

sage: y = Word('1236777') 

sage: w.longest_common_prefix(y) 

word: 123 

sage: w.longest_common_prefix(w) 

word: 12345 

sage: y.longest_common_prefix(w) 

word: 123 

sage: y.longest_common_prefix(y) 

word: 1236777 

sage: Word().longest_common_prefix(w) 

word: 

sage: w.longest_common_prefix(Word()) 

word: 

sage: w.longest_common_prefix(w[:3]) 

word: 123 

sage: Word("11").longest_common_prefix(Word("1")) 

word: 1 

sage: Word("1").longest_common_prefix(Word("11")) 

word: 1 

 

With infinite words:: 

 

sage: t = words.ThueMorseWord('ab') 

sage: u = t[:10] 

sage: u.longest_common_prefix(t) 

word: abbabaabba 

sage: u.longest_common_prefix(u) 

word: abbabaabba 

 

Check length:: 

 

sage: w1 = Word(iter('ab'*200)) 

sage: w2 = Word(iter('bcd'*200)) 

sage: w1.longest_common_prefix(w2, length=19) 

Traceback (most recent call last): 

... 

ValueError: invalid argument length (=19) 

""" 

it = self._longest_common_prefix_iterator(other) 

 

if length == "finite" or \ 

(length == "unknown" and (self.is_finite() or other.is_finite())): 

parent = self._parent.factors() 

elif length == "infinite": 

parent = self._parent.shift() 

elif length == "unknown": 

from sage.combinat.words.words import FiniteOrInfiniteWords 

parent = FiniteOrInfiniteWords(self._parent.alphabet()) 

else: 

raise ValueError("invalid argument length (={})".format(length)) 

 

return parent(it) 

 

def _longest_periodic_prefix_iterator(self, period=1): 

r""" 

Returns an iterator of the longest prefix of self having the given 

period. 

 

INPUT: 

 

- ``period`` - positive integer (optional, default 1) 

 

OUTPUT: 

 

iterator 

 

EXAMPLES:: 

 

sage: list(Word([])._longest_periodic_prefix_iterator()) 

[] 

sage: list(Word([1])._longest_periodic_prefix_iterator()) 

[1] 

sage: list(Word([1,2])._longest_periodic_prefix_iterator()) 

[1] 

sage: list(Word([1,1,2])._longest_periodic_prefix_iterator()) 

[1, 1] 

sage: list(Word([1,1,1,2])._longest_periodic_prefix_iterator()) 

[1, 1, 1] 

sage: Word(Word(lambda n:0)._longest_periodic_prefix_iterator()) 

word: 0000000000000000000000000000000000000000... 

sage: list(Word([1,2,1,2,1,3])._longest_periodic_prefix_iterator(2)) 

[1, 2, 1, 2, 1] 

""" 

for i, l in enumerate(self): 

if self[i % period] == l: 

yield l 

else: 

break 

 

def longest_periodic_prefix(self, period=1): 

r""" 

Returns the longest prefix of self having the given period. 

 

INPUT: 

 

- ``period`` - positive integer (optional, default 1) 

 

OUTPUT: 

 

word 

 

EXAMPLES:: 

 

sage: Word([]).longest_periodic_prefix() 

word: 

sage: Word([1]).longest_periodic_prefix() 

word: 1 

sage: Word([1,2]).longest_periodic_prefix() 

word: 1 

sage: Word([1,1,2]).longest_periodic_prefix() 

word: 11 

sage: Word([1,2,1,2,1,3]).longest_periodic_prefix(2) 

word: 12121 

sage: type(_) 

<class 'sage.combinat.words.word.FiniteWord_iter_with_caching'> 

sage: Word(lambda n:0).longest_periodic_prefix() 

word: 0000000000000000000000000000000000000000... 

""" 

if self.is_finite(): 

parent = self._parent.factors() 

else: 

from sage.combinat.words.words import FiniteOrInfiniteWords 

parent = FiniteOrInfiniteWords(self._parent.alphabet()) 

return parent(self._longest_periodic_prefix_iterator(period)) 

 

def is_empty(self): 

r""" 

Returns True if the length of self is zero, and False otherwise. 

 

EXAMPLES:: 

 

sage: it = iter([]) 

sage: Word(it).is_empty() 

True 

sage: it = iter([1,2,3]) 

sage: Word(it).is_empty() 

False 

sage: from itertools import count 

sage: Word(count()).is_empty() 

False 

""" 

try: 

next(iter(self)) 

return False 

except StopIteration: 

return True 

 

def _to_integer_iterator(self, use_parent_alphabet=False): 

r""" 

Returns an iterator over the letters of an integer representation of 

self. 

 

INPUT: 

 

- ``use_parent_alphabet`` - Bool (default: False). When True and if 

the self parent's alphabet is finite, it uses the index of 

the letters in the alphabet. Otherwise, the first letter occurring in 

self is mapped to zero, and every letter that hasn't yet occurred in 

the word is mapped to the next available integer. 

 

EXAMPLES:: 

 

sage: from itertools import count 

sage: w = Word(count()) 

sage: ir = w._to_integer_iterator() 

sage: [next(ir) for _ in range(10)] 

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9] 

sage: w = Word(iter("abbacabba")) 

sage: ir = w._to_integer_iterator() 

sage: list(ir) 

[0, 1, 1, 0, 2, 0, 1, 1, 0] 

 

:: 

 

sage: w = Words('abc')('abbccc') 

sage: list(w._to_integer_iterator(True)) 

[0, 1, 1, 2, 2, 2] 

sage: w = Words('acb')('abbccc') 

sage: list(w._to_integer_iterator(True)) 

[0, 2, 2, 1, 1, 1] 

sage: w = Words('xabc')('abbccc') 

sage: list(w._to_integer_iterator(True)) 

[1, 2, 2, 3, 3, 3] 

""" 

from sage.combinat.words.words import FiniteWords, InfiniteWords 

if use_parent_alphabet and\ 

isinstance(self.parent(), (FiniteWords,InfiniteWords)): 

A = self.parent().alphabet() 

for letter in self: 

yield A.rank(letter) 

 

else: 

mapping = {} 

next_value = 0 

for letter in self: 

if not(letter in mapping): 

mapping[letter] = next_value 

next_value += 1 

yield mapping[letter] 

 

def to_integer_word(self): 

r""" 

Returns a word over the integers whose letters are those output by 

self._to_integer_iterator() 

 

EXAMPLES:: 

 

sage: from itertools import count 

sage: w = Word(count()); w 

word: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,... 

sage: w.to_integer_word() 

word: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,... 

sage: w = Word(iter("abbacabba"), length="finite"); w 

word: abbacabba 

sage: w.to_integer_word() 

word: 011020110 

sage: w = Word(iter("abbacabba"), length="unknown"); w 

word: abbacabba 

sage: w.to_integer_word() 

word: 011020110 

""" 

length = "unknown" if self._len is None else self._len 

from sage.combinat.words.word import Word 

return Word(self._to_integer_iterator(), length=length) 

 

def lex_less(self, other): 

r""" 

Returns True if self is lexicographically less than other. 

 

EXAMPLES:: 

 

sage: w = Word([1,2,3]) 

sage: u = Word([1,3,2]) 

sage: v = Word([3,2,1]) 

sage: w.lex_less(u) 

True 

sage: v.lex_less(w) 

False 

sage: a = Word("abba") 

sage: b = Word("abbb") 

sage: a.lex_less(b) 

True 

sage: b.lex_less(a) 

False 

 

For infinite words:: 

 

sage: t = words.ThueMorseWord() 

sage: t.lex_less(t[:10]) 

False 

sage: t[:10].lex_less(t) 

True 

""" 

return richcmp(self, other, op_LT) 

 

def lex_greater(self, other): 

r""" 

Returns True if self is lexicographically greater than other. 

 

EXAMPLES:: 

 

sage: w = Word([1,2,3]) 

sage: u = Word([1,3,2]) 

sage: v = Word([3,2,1]) 

sage: w.lex_greater(u) 

False 

sage: v.lex_greater(w) 

True 

sage: a = Word("abba") 

sage: b = Word("abbb") 

sage: a.lex_greater(b) 

False 

sage: b.lex_greater(a) 

True 

 

For infinite words:: 

 

sage: t = words.ThueMorseWord() 

sage: t[:10].lex_greater(t) 

False 

sage: t.lex_greater(t[:10]) 

True 

""" 

return richcmp(self, other, op_GT) 

 

def apply_morphism(self, morphism): 

r""" 

Returns the word obtained by applying the morphism to self. 

 

INPUT: 

 

- ``morphism`` - Can be an instance of WordMorphism, or 

anything that can be used to construct one. 

 

EXAMPLES:: 

 

sage: w = Word("ab") 

sage: d = {'a':'ab', 'b':'ba'} 

sage: w.apply_morphism(d) 

word: abba 

sage: w.apply_morphism(WordMorphism(d)) 

word: abba 

 

:: 

 

sage: w = Word('ababa') 

sage: d = dict(a='ab', b='ba') 

sage: d 

{'a': 'ab', 'b': 'ba'} 

sage: w.apply_morphism(d) 

word: abbaabbaab 

 

For infinite words:: 

 

sage: t = words.ThueMorseWord([0,1]); t 

word: 0110100110010110100101100110100110010110... 

sage: t.apply_morphism({0:8,1:9}) 

word: 8998988998898998988989988998988998898998... 

""" 

from sage.combinat.words.morphism import WordMorphism 

if not isinstance(morphism, WordMorphism): 

morphism = WordMorphism(morphism) 

return morphism(self) 

 

def _delta_iterator(self): 

r""" 

Returns an iterator of the image of self under the delta morphism. 

This is the word composed of the length of consecutive runs of the 

same letter in a given word. 

 

OUTPUT: 

 

generator object 

 

EXAMPLES:: 

 

sage: W = Words('0123456789') 

sage: it=W('22112122')._delta_iterator() 

sage: Word(it) 

word: 22112 

sage: Word(W('555008')._delta_iterator()) 

word: 321 

sage: Word(W()._delta_iterator()) 

word: 

 

For infinite words:: 

 

sage: t = words.ThueMorseWord() 

sage: it = t._delta_iterator() 

sage: Word(it) 

word: 1211222112112112221122211222112112112221... 

""" 

for letter, run in groupby(self): 

yield len(list(run)) 

 

def delta(self): 

r""" 

Returns the image of self under the delta morphism. 

 

This is the word composed of the length of consecutive runs of 

the same letter in a given word. 

 

OUTPUT: 

 

Word over integers 

 

EXAMPLES: 

 

For finite words:: 

 

sage: W = Words('0123456789') 

sage: W('22112122').delta() 

word: 22112 

sage: W('555008').delta() 

word: 321 

sage: W().delta() 

word: 

sage: Word('aabbabaa').delta() 

word: 22112 

 

For infinite words:: 

 

sage: t = words.ThueMorseWord() 

sage: t.delta() 

word: 1211222112112112221122211222112112112221... 

""" 

from sage.combinat.words.word import Word 

from sage.rings.semirings.non_negative_integer_semiring import NN 

return Word(self._delta_iterator(), alphabet=NN) 

 

def _iterated_right_palindromic_closure_iterator(self, f=None): 

r""" 

Returns an iterator over the iterated (`f`-)palindromic closure of self. 

 

INPUT: 

 

- ``f`` - involution (default: None) on the alphabet of self. It must 

be callable on letters as well as words (e.g. WordMorphism). 

 

OUTPUT: 

 

iterator -- the iterated (`f`-)palindromic closure of self 

 

EXAMPLES:: 

 

sage: w = Word('abc') 

sage: it = w._iterated_right_palindromic_closure_iterator() 

sage: Word(it) 

word: abacaba 

 

:: 

 

sage: w = Word('aaa') 

sage: it = w._iterated_right_palindromic_closure_iterator() 

sage: Word(it) 

word: aaa 

 

:: 

 

sage: w = Word('abbab') 

sage: it = w._iterated_right_palindromic_closure_iterator() 

sage: Word(it) 

word: ababaabababaababa 

 

An infinite word:: 

 

sage: t = words.ThueMorseWord('ab') 

sage: it = t._iterated_right_palindromic_closure_iterator() 

sage: Word(it) 

word: ababaabababaababaabababaababaabababaabab... 

 

TESTS: 

 

The empty word:: 

 

sage: w = Word() 

sage: it = w._iterated_right_palindromic_closure_iterator() 

sage: next(it) 

Traceback (most recent call last): 

... 

StopIteration 

 

REFERENCES: 

 

- [1] A. de Luca, A. De Luca, Pseudopalindrome closure operators 

in free monoids, Theoret. Comput. Sci. 362 (2006) 282--300. 

""" 

par = self.parent().factors() 

w = self[:0] 

for letter in self: 

length_before = w.length() 

w = (w*par([letter])).palindromic_closure(f=f) 

length_after = w.length() 

d = length_after - length_before 

for a in w[-d:]: 

yield a 

 

def _iterated_right_palindromic_closure_recursive_iterator(self, f=None): 

r""" 

Returns an iterator over the iterated (`f`-)palindromic closure of self. 

 

INPUT: 

 

- ``f`` - involution (default: None) on the alphabet of self. It must 

be callable on letters as well as words (e.g. WordMorphism). 

 

OUTPUT: 

 

iterator -- the iterated (`f`-)palindromic closure of self 

 

ALGORITHM: 

 

For the case of palindromes only, it has been shown in [2] that 

the iterated right palindromic closure of a given word `w`, 

denoted by `IRPC(w)`, may be obtained as follows. 

Let `w` be any word and `x` be a letter. Then 

 

#. If `x` does not occur in `w`, 

`IRPC(wx) = IRPC(w) \cdot x \cdot IRPC(w)` 

#. Otherwise, write `w = w_1xw_2` such that `x` does not 

occur in `w_2`. Then `IRPC(wx) = IRPC(w) \cdot IRPC(w_1)^{-1} 

\cdot IRPC(w)` 

 

This formula is directly generalized to the case of `f`-palindromes. 

See [1] for more details. 

 

EXAMPLES:: 

 

sage: w = Word('abc') 

sage: it = w._iterated_right_palindromic_closure_recursive_iterator() 

sage: Word(it) 

word: abacaba 

 

:: 

 

sage: w = Word('aaa') 

sage: it = w._iterated_right_palindromic_closure_recursive_iterator() 

sage: Word(it) 

word: aaa 

 

:: 

 

sage: w = Word('abbab') 

sage: it = w._iterated_right_palindromic_closure_recursive_iterator() 

sage: Word(it) 

word: ababaabababaababa 

 

An infinite word:: 

 

sage: t = words.ThueMorseWord('ab') 

sage: it = t._iterated_right_palindromic_closure_recursive_iterator() 

sage: Word(it) 

word: ababaabababaababaabababaababaabababaabab... 

 

TESTS: 

 

The empty word:: 

 

sage: w = Word() 

sage: it = w._iterated_right_palindromic_closure_recursive_iterator() 

sage: next(it) 

Traceback (most recent call last): 

... 

StopIteration 

 

REFERENCES: 

 

- [1] A. de Luca, A. De Luca, Pseudopalindrome closure operators 

in free monoids, Theoret. Comput. Sci. 362 (2006) 282--300. 

- [2] J. Justin, Episturmian morphisms and a Galois theorem on 

continued fractions, RAIRO Theoret. Informatics Appl. 39 (2005) 

207-215. 

""" 

parent = self.parent().factors() 

ipcw = self[:0] 

lengths = [] 

for i, letter in enumerate(self): 

lengths.append(ipcw.length()) 

w = self[:i] 

pos = w.rfind(parent([letter])) 

if pos == -1: 

to_append = parent([letter]).palindromic_closure(f=f) + ipcw 

else: 

to_append = ipcw[lengths[pos]:] 

ipcw += to_append 

for a in to_append: 

yield a 

 

def iterated_right_palindromic_closure(self, f=None, algorithm='recursive'): 

r""" 

Returns the iterated (`f`-)palindromic closure of self. 

 

INPUT: 

 

- ``f`` - involution (default: None) on the alphabet of self. It must 

be callable on letters as well as words (e.g. WordMorphism). 

 

- ``algorithm`` - string (default: ``'recursive'``) specifying which 

algorithm to be used when computing the iterated palindromic closure. 

It must be one of the two following values: 

 

- ``'definition'`` - computed using the definition 

- ``'recursive'`` - computation based on an efficient formula 

that recursively computes the iterated right palindromic closure 

without having to recompute the longest `f`-palindromic suffix 

at each iteration [2]. 

 

OUTPUT: 

 

word -- the iterated (`f`-)palindromic closure of self 

 

EXAMPLES:: 

 

sage: Word('123').iterated_right_palindromic_closure() 

word: 1213121 

 

:: 

 

sage: w = Word('abc') 

sage: w.iterated_right_palindromic_closure() 

word: abacaba 

 

:: 

 

sage: w = Word('aaa') 

sage: w.iterated_right_palindromic_closure() 

word: aaa 

 

:: 

 

sage: w = Word('abbab') 

sage: w.iterated_right_palindromic_closure() 

word: ababaabababaababa 

 

A right `f`-palindromic closure:: 

 

sage: f = WordMorphism('a->b,b->a') 

sage: w = Word('abbab') 

sage: w.iterated_right_palindromic_closure(f=f) 

word: abbaabbaababbaabbaabbaababbaabbaab 

 

An infinite word:: 

 

sage: t = words.ThueMorseWord('ab') 

sage: t.iterated_right_palindromic_closure() 

word: ababaabababaababaabababaababaabababaabab... 

 

There are two implementations computing the iterated right 

`f`-palindromic closure, the latter being much more efficient:: 

 

sage: w = Word('abaab') 

sage: u = w.iterated_right_palindromic_closure(algorithm='definition') 

sage: v = w.iterated_right_palindromic_closure(algorithm='recursive') 

sage: u 

word: abaabaababaabaaba 

sage: u == v 

True 

sage: w = words.RandomWord(8) 

sage: u = w.iterated_right_palindromic_closure(algorithm='definition') 

sage: v = w.iterated_right_palindromic_closure(algorithm='recursive') 

sage: u == v 

True 

 

TESTS: 

 

The empty word:: 

 

sage: w = Word() 

sage: w.iterated_right_palindromic_closure() 

word: 

 

The length-`1` word:: 

 

sage: Word('1').iterated_right_palindromic_closure() 

word: 1 

 

If the word is finite, so is the result:: 

 

sage: w = Word([0,1]*7) 

sage: c = w.iterated_right_palindromic_closure() 

sage: type(c) 

<class 'sage.combinat.words.word.FiniteWord_iter_with_caching'> 

 

REFERENCES: 

 

- [1] A. de Luca, A. De Luca, Pseudopalindrome closure operators 

in free monoids, Theoret. Comput. Sci. 362 (2006) 282--300. 

- [2] J. Justin, Episturmian morphisms and a Galois theorem on 

continued fractions, RAIRO Theoret. Informatics Appl. 39 (2005) 

207-215. 

""" 

if algorithm == 'definition': 

it = self._iterated_right_palindromic_closure_iterator(f=f) 

elif algorithm == 'recursive': 

it = self._iterated_right_palindromic_closure_recursive_iterator(f=f) 

else: 

raise ValueError("algorithm (=%s) must be either 'definition' or 'recursive'") 

 

if self.is_finite(): 

return self._parent(it) 

else: 

from sage.combinat.words.words import Words 

parent = Words(self._parent.alphabet()) 

return parent(it) 

 

def prefixes_iterator(self, max_length=None): 

r""" 

Returns an iterator over the prefixes of self. 

 

INPUT: 

 

- ``max_length`` - non negative integer or None (optional, 

default: None) the maximum length of the prefixes 

 

OUTPUT: 

 

iterator 

 

EXAMPLES:: 

 

sage: w = Word('abaaba') 

sage: for p in w.prefixes_iterator(): p 

word: 

word: a 

word: ab 

word: aba 

word: abaa 

word: abaab 

word: abaaba 

sage: for p in w.prefixes_iterator(max_length=3): p 

word: 

word: a 

word: ab 

word: aba 

 

You can iterate over the prefixes of an infinite word:: 

 

sage: f = words.FibonacciWord() 

sage: for p in f.prefixes_iterator(max_length=8): p 

word: 

word: 0 

word: 01 

word: 010 

word: 0100 

word: 01001 

word: 010010 

word: 0100101 

word: 01001010 

 

TESTS:: 

 

sage: list(f.prefixes_iterator(max_length=0)) 

[word: ] 

""" 

to_consider = self if max_length is None else self[:max_length] 

yield self[:0] 

for (i,a) in enumerate(to_consider): 

yield self[:i+1] 

 

def palindrome_prefixes_iterator(self, max_length=None): 

r""" 

Returns an iterator over the palindrome prefixes of self. 

 

INPUT: 

 

- ``max_length`` - non negative integer or None (optional, 

default: None) the maximum length of the prefixes 

 

OUTPUT: 

 

iterator 

 

EXAMPLES:: 

 

sage: w = Word('abaaba') 

sage: for pp in w.palindrome_prefixes_iterator(): pp 

word: 

word: a 

word: aba 

word: abaaba 

sage: for pp in w.palindrome_prefixes_iterator(max_length=4): pp 

word: 

word: a 

word: aba 

 

You can iterate over the palindrome prefixes of an infinite word:: 

 

sage: f = words.FibonacciWord() 

sage: for pp in f.palindrome_prefixes_iterator(max_length=20): pp 

word: 

word: 0 

word: 010 

word: 010010 

word: 01001010010 

word: 0100101001001010010 

""" 

for p in self.prefixes_iterator(max_length): 

if p.is_palindrome(): 

yield p 

 

def _partial_sums_iterator(self, start, mod=None): 

r""" 

Iterator over the partial sums of the prefixes of self. 

 

INPUT: 

 

- ``self`` - A word over the integers. 

- ``start`` - integer, the first letter of the resulting word. 

- ``mod`` - (default: None) It can be one of the following: 

- None or 0 : result is over the integers 

- integer : result is over the integers modulo ``mod``. 

 

EXAMPLES:: 

 

sage: w = Word(range(8)) 

sage: list(w._partial_sums_iterator(0, mod=10)) 

[0, 0, 1, 3, 6, 0, 5, 1, 8] 

 

:: 

 

sage: w = Word([1,1,1,1,1,1,1,1,1,1,1,1]) 

sage: list(w._partial_sums_iterator(0, mod=10)) 

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2] 

 

:: 

 

sage: w = Word([1,1,1,1,1,1,1,1,1,1,1,1]) 

sage: list(w._partial_sums_iterator(0)) 

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12] 

 

""" 

if mod in (None, 0): 

sum = start 

 

elif mod in ZZ: 

Zn = Integers(mod) 

sum = Zn(start) 

 

else: 

raise TypeError('mod(=%s) must be None or an integer'%mod) 

 

yield sum 

for letter in self: 

sum += letter 

yield sum 

 

def partial_sums(self, start, mod=None): 

r""" 

Returns the word defined by the partial sums of its prefixes. 

 

INPUT: 

 

- ``self`` - A word over the integers. 

- ``start`` - integer, the first letter of the resulting word. 

- ``mod`` - (default: None) It can be one of the following: 

- None or 0 : result is over the integers 

- integer : result is over the integers modulo ``mod``. 

 

EXAMPLES:: 

 

sage: w = Word(range(10)) 

sage: w.partial_sums(0) 

word: 0,0,1,3,6,10,15,21,28,36,45 

sage: w.partial_sums(1) 

word: 1,1,2,4,7,11,16,22,29,37,46 

 

:: 

 

sage: w = Word([1,2,3,1,2,3,2,2,2,2]) 

sage: w.partial_sums(0, mod=None) 

word: 0,1,3,6,7,9,12,14,16,18,20 

sage: w.partial_sums(0, mod=0) 

word: 0,1,3,6,7,9,12,14,16,18,20 

sage: w.partial_sums(0, mod=8) 

word: 01367146024 

sage: w.partial_sums(0, mod=4) 

word: 01323102020 

sage: w.partial_sums(0, mod=2) 

word: 01101100000 

sage: w.partial_sums(0, mod=1) 

word: 00000000000 

 

TESTS: 

 

If the word is infinite, so is the result:: 

 

sage: w = Word(lambda n:1) 

sage: u = w.partial_sums(0) 

sage: type(u) 

<class 'sage.combinat.words.word.InfiniteWord_iter_with_caching'> 

""" 

it = self._partial_sums_iterator(start=start, mod=mod) 

 

if mod in (None, 0): 

alphabet = None 

elif mod in ZZ: 

alphabet = Integers(mod) 

 

if self.is_finite(): 

length = "finite" 

elif self.length() == Infinity: 

length = "infinite" 

else: 

length = "unknown" 

from sage.combinat.words.word import Word 

return Word(it, alphabet=alphabet, length=length) 

 

def _finite_differences_iterator(self, mod=None): 

r""" 

Iterator over the diffences of consecutive letters of self. 

 

INPUT: 

 

- ``self`` - A word over the integers. 

- ``mod`` - (default: None) It can be one of the following: 

- None or 0 : result is over the integers 

- integer : result is over the integers modulo ``mod``. 

 

EXAMPLES:: 

 

sage: w = Word(x^2 for x in range(10)) 

sage: list(w._finite_differences_iterator()) 

[1, 3, 5, 7, 9, 11, 13, 15, 17] 

 

:: 

 

sage: w = Word([1,6,8,4,2,6,8,2,3]) 

sage: list(w._finite_differences_iterator()) 

[5, 2, -4, -2, 4, 2, -6, 1] 

sage: list(w._finite_differences_iterator(4)) 

[1, 2, 0, 2, 0, 2, 2, 1] 

sage: list(w._finite_differences_iterator(5)) 

[0, 2, 1, 3, 4, 2, 4, 1] 

 

TESTS:: 

 

sage: w = Word([2,3,6]) 

sage: list(w._finite_differences_iterator()) 

[1, 3] 

sage: w = Word([2,6]) 

sage: list(w._finite_differences_iterator()) 

[4] 

sage: w = Word([2]) 

sage: list(w._finite_differences_iterator()) 

[] 

sage: w = Word() 

sage: list(w._finite_differences_iterator()) 

[] 

 

:: 

 

sage: list(w._finite_differences_iterator('a')) 

Traceback (most recent call last): 

... 

TypeError: mod(=a) must be None or an integer 

""" 

if mod in (None, 0): 

i = iter(self) 

j = iter(self) 

next(j) 

while True: 

yield next(j) - next(i) 

 

elif mod in ZZ: 

Zn = Integers(mod) 

i = iter(self) 

j = iter(self) 

next(j) 

while True: 

yield Zn(next(j) - next(i)) 

 

else: 

raise TypeError('mod(=%s) must be None or an integer'%mod) 

 

def finite_differences(self, mod=None): 

r""" 

Returns the word obtained by the diffences of consecutive letters 

of self. 

 

INPUT: 

 

- ``self`` - A word over the integers. 

- ``mod`` - (default: None) It can be one of the following: 

- None or 0 : result is over the integers 

- integer : result is over the integers modulo ``mod``. 

 

EXAMPLES:: 

 

sage: w = Word([x^2 for x in range(10)]) 

sage: w.finite_differences() 

word: 1,3,5,7,9,11,13,15,17 

sage: w.finite_differences(mod=4) 

word: 131313131 

sage: w.finite_differences(mod=0) 

word: 1,3,5,7,9,11,13,15,17 

 

TESTS:: 

 

sage: w = Word([2,3,6]) 

sage: w.finite_differences() 

word: 13 

sage: w = Word([2,6]) 

sage: w.finite_differences() 

word: 4 

sage: w = Word([2]) 

sage: w.finite_differences() 

word: 

sage: w = Word() 

sage: w.finite_differences() 

word: 

 

If the word is infinite, so is the result:: 

 

sage: w = Word(lambda n:n) 

sage: u = w.finite_differences() 

sage: u 

word: 1111111111111111111111111111111111111111... 

sage: type(u) 

<class 'sage.combinat.words.word.InfiniteWord_iter_with_caching'> 

""" 

it = self._finite_differences_iterator(mod=mod) 

 

if mod in (None, 0): 

alphabet = None 

elif mod in ZZ: 

alphabet = Integers(mod) 

 

if self.is_finite(): 

length = "finite" 

elif self.length() == Infinity: 

length = "infinite" 

else: 

length = "unknown" 

from sage.combinat.words.word import Word 

return Word(it, alphabet=alphabet, length=length) 

 

def sum_digits(self, base=2, mod=None): 

r""" 

Return the sequence of the sum modulo ``mod`` of the digits written 

in base ``base`` of ``self``. 

 

INPUT: 

 

- ``self`` - word over natural numbers 

 

- ``base`` - integer (default : 2), greater or equal to 2 

 

- ``mod`` - modulo (default: ``None``), can take the following 

values: 

 

- integer -- the modulo 

 

- ``None`` - the value ``base`` is considered for the modulo. 

 

EXAMPLES: 

 

The Thue-Morse word:: 

 

sage: from itertools import count 

sage: Word(count()).sum_digits() 

word: 0110100110010110100101100110100110010110... 

 

Sum of digits modulo 2 of the prime numbers written in base 2:: 

 

sage: Word(primes(1000)).sum_digits() 

word: 1001110100111010111011001011101110011011... 

 

Sum of digits modulo 3 of the prime numbers written in base 3:: 

 

sage: Word(primes(1000)).sum_digits(base=3) 

word: 2100002020002221222121022221022122111022... 

sage: Word(primes(1000)).sum_digits(base=3, mod=3) 

word: 2100002020002221222121022221022122111022... 

 

Sum of digits modulo 2 of the prime numbers written in base 3:: 

 

sage: Word(primes(1000)).sum_digits(base=3, mod=2) 

word: 0111111111111111111111111111111111111111... 

 

Sum of digits modulo 7 of the prime numbers written in base 10:: 

 

sage: Word(primes(1000)).sum_digits(base=10, mod=7) 

word: 2350241354435041006132432241353546006304... 

 

Negative entries:: 

 

sage: w = Word([-1,0,1,2,3,4,5]) 

sage: w.sum_digits() 

Traceback (most recent call last): 

... 

NotImplementedError: nth digit of Thue-Morse word is not implemented for negative value of n 

 

TESTS: 

 

The Thue-Morse word:: 

 

sage: from itertools import count 

sage: w = Word(count()).sum_digits() 

sage: t = words.ThueMorseWord() 

sage: w[:100] == t[:100] 

True 

 

:: 

 

sage: type(Word(range(10)).sum_digits()) 

<class 'sage.combinat.words.word.FiniteWord_iter_with_caching'> 

""" 

from functools import partial 

from sage.combinat.words.word_generators import words 

 

# The alphabet 

if mod is None and base >= 2: 

alphabet = list(range(base)) 

elif mod in ZZ and mod >= 2: 

alphabet = list(range(mod)) 

else: 

raise ValueError("base (=%s) and mod (=%s) must be integers greater or equal to 2"%(base, mod)) 

 

# The iterator 

f = partial(words._ThueMorseWord_nth_digit, alphabet=alphabet, base=base) 

it = (f(a) for a in self) 

 

# The length 

if self.is_finite(): 

length = "finite" 

elif self.length() == Infinity: 

length = None 

else: 

length = "unknown" 

 

from sage.combinat.words.word import Word 

return Word(it, alphabet=alphabet, length=length, datatype='iter') 

 

def factor_occurrences_iterator(self, fact): 

r""" 

Returns an iterator over all occurrences (including overlapping ones) 

of fact in self in their order of appearance. 

 

INPUT: 

 

- ``fact`` - a non empty finite word 

 

OUTPUT: 

 

iterator 

 

EXAMPLES:: 

 

sage: TM = words.ThueMorseWord() 

sage: fact = Word([0,1,1,0,1]) 

sage: it = TM.factor_occurrences_iterator(fact) 

sage: next(it) 

0 

sage: next(it) 

12 

sage: next(it) 

24 

""" 

if fact.is_empty(): 

raise NotImplementedError("The factor must be non empty") 

if not fact.is_finite(): 

raise ValueError("The factor must be finite") 

p = fact._pos_in(self, 0) 

while p is not None: 

yield p 

p = fact._pos_in(self, p+1) 

 

def return_words_iterator(self, fact): 

r""" 

Returns an iterator over all the return words of fact in self 

(without unicity). 

 

INPUT: 

 

- ``fact`` - a non empty finite word 

 

OUTPUT: 

 

iterator 

 

EXAMPLES:: 

 

sage: w = Word('baccabccbacbca') 

sage: b = Word('b') 

sage: list(w.return_words_iterator(b)) 

[word: bacca, word: bcc, word: bac] 

 

:: 

 

sage: TM = words.ThueMorseWord() 

sage: fact = Word([0,1,1,0,1]) 

sage: it = TM.return_words_iterator(fact) 

sage: next(it) 

word: 011010011001 

sage: next(it) 

word: 011010010110 

sage: next(it) 

word: 0110100110010110 

sage: next(it) 

word: 01101001 

sage: next(it) 

word: 011010011001 

sage: next(it) 

word: 011010010110 

""" 

it = self.factor_occurrences_iterator(fact) 

i = next(it) 

while True: 

j = next(it) 

yield self[i:j] 

i = j 

 

def complete_return_words_iterator(self, fact): 

r""" 

Returns an iterator over all the complete return words of fact in 

self (without unicity). 

 

A complete return words `u` of a factor `v` is a factor starting 

by the given factor `v` and ending just after the next occurrence 

of this factor `v`. See for instance [1]. 

 

INPUT: 

 

- ``fact`` - a non empty finite word 

 

OUTPUT: 

 

iterator 

 

EXAMPLES:: 

 

sage: TM = words.ThueMorseWord() 

sage: fact = Word([0,1,1,0,1]) 

sage: it = TM.complete_return_words_iterator(fact) 

sage: next(it) 

word: 01101001100101101 

sage: next(it) 

word: 01101001011001101 

sage: next(it) 

word: 011010011001011001101 

sage: next(it) 

word: 0110100101101 

sage: next(it) 

word: 01101001100101101 

sage: next(it) 

word: 01101001011001101 

 

REFERENCES: 

 

- [1] J. Justin, L. Vuillon, Return words in Sturmian and 

episturmian words, Theor. Inform. Appl. 34 (2000) 343--356. 

""" 

it = self.factor_occurrences_iterator(fact) 

L = fact.length() 

i = next(it) 

while True: 

j = next(it) 

yield self[i:j+L] 

i = j