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

from __future__ import print_function, division 

 

from functools import wraps 

 

from sympy.core import S, Symbol, Tuple, Integer, Basic, Expr 

from sympy.core.decorators import call_highest_priority 

from sympy.core.compatibility import range 

from sympy.core.sympify import SympifyError, sympify 

from sympy.functions import conjugate, adjoint 

from sympy.matrices import ShapeError 

from sympy.simplify import simplify 

 

 

def _sympifyit(arg, retval=None): 

    # This version of _sympifyit sympifies MutableMatrix objects 

    def deco(func): 

        @wraps(func) 

        def __sympifyit_wrapper(a, b): 

            try: 

                b = sympify(b, strict=True) 

                return func(a, b) 

            except SympifyError: 

                return retval 

 

        return __sympifyit_wrapper 

 

    return deco 

 

 

class MatrixExpr(Basic): 

    """ Superclass for Matrix Expressions 

 

    MatrixExprs represent abstract matrices, linear transformations represented 

    within a particular basis. 

 

    Examples 

    ======== 

 

    >>> from sympy import MatrixSymbol 

    >>> A = MatrixSymbol('A', 3, 3) 

    >>> y = MatrixSymbol('y', 3, 1) 

    >>> x = (A.T*A).I * A * y 

 

    See Also 

    ======== 

        MatrixSymbol 

        MatAdd 

        MatMul 

        Transpose 

        Inverse 

    """ 

 

    _op_priority = 11.0 

 

    is_Matrix = True 

    is_MatrixExpr = True 

    is_Identity = None 

    is_Inverse = False 

    is_Transpose = False 

    is_ZeroMatrix = False 

    is_MatAdd = False 

    is_MatMul = False 

 

    is_commutative = False 

 

 

    def __new__(cls, *args, **kwargs): 

        args = map(sympify, args) 

        return Basic.__new__(cls, *args, **kwargs) 

 

    # The following is adapted from the core Expr object 

    def __neg__(self): 

        return MatMul(S.NegativeOne, self).doit() 

 

    def __abs__(self): 

        raise NotImplementedError 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__radd__') 

    def __add__(self, other): 

        return MatAdd(self, other).doit() 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__add__') 

    def __radd__(self, other): 

        return MatAdd(other, self).doit() 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__rsub__') 

    def __sub__(self, other): 

        return MatAdd(self, -other).doit() 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__sub__') 

    def __rsub__(self, other): 

        return MatAdd(other, -self).doit() 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__rmul__') 

    def __mul__(self, other): 

        return MatMul(self, other).doit() 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__mul__') 

    def __rmul__(self, other): 

        return MatMul(other, self).doit() 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__rpow__') 

    def __pow__(self, other): 

        if not self.is_square: 

            raise ShapeError("Power of non-square matrix %s" % self) 

        if other is S.NegativeOne: 

            return Inverse(self) 

        elif other is S.Zero: 

            return Identity(self.rows) 

        elif other is S.One: 

            return self 

        return MatPow(self, other) 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__pow__') 

    def __rpow__(self, other): 

        raise NotImplementedError("Matrix Power not defined") 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__rdiv__') 

    def __div__(self, other): 

        return self * other**S.NegativeOne 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__div__') 

    def __rdiv__(self, other): 

        raise NotImplementedError() 

        #return MatMul(other, Pow(self, S.NegativeOne)) 

 

    __truediv__ = __div__ 

    __rtruediv__ = __rdiv__ 

 

    @property 

    def rows(self): 

        return self.shape[0] 

 

    @property 

    def cols(self): 

        return self.shape[1] 

 

    @property 

    def is_square(self): 

        return self.rows == self.cols 

 

    def _eval_conjugate(self): 

        from sympy.matrices.expressions.adjoint import Adjoint 

        from sympy.matrices.expressions.transpose import Transpose 

        return Adjoint(Transpose(self)) 

 

    def _eval_inverse(self): 

        from sympy.matrices.expressions.inverse import Inverse 

        return Inverse(self) 

 

    def _eval_transpose(self): 

        return Transpose(self) 

 

    def _eval_power(self, exp): 

        return MatPow(self, exp) 

 

    def _eval_simplify(self, **kwargs): 

        if self.is_Atom: 

            return self 

        else: 

            return self.__class__(*[simplify(x, **kwargs) for x in self.args]) 

 

    def _eval_adjoint(self): 

        from sympy.matrices.expressions.adjoint import Adjoint 

        return Adjoint(self) 

 

    def _entry(self, i, j): 

        raise NotImplementedError( 

            "Indexing not implemented for %s" % self.__class__.__name__) 

 

    def adjoint(self): 

        return adjoint(self) 

 

    def conjugate(self): 

        return conjugate(self) 

 

    def transpose(self): 

        from sympy.matrices.expressions.transpose import transpose 

        return transpose(self) 

 

    T = property(transpose, None, None, 'Matrix transposition.') 

 

    def inverse(self): 

        return self._eval_inverse() 

 

    @property 

    def I(self): 

        return self.inverse() 

 

    def valid_index(self, i, j): 

        def is_valid(idx): 

            return isinstance(idx, (int, Integer, Symbol, Expr)) 

        return (is_valid(i) and is_valid(j) and 

                (0 <= i) != False and (i < self.rows) != False and 

                (0 <= j) != False and (j < self.cols) != False) 

 

    def __getitem__(self, key): 

        if not isinstance(key, tuple) and isinstance(key, slice): 

            from sympy.matrices.expressions.slice import MatrixSlice 

            return MatrixSlice(self, key, (0, None, 1)) 

        if isinstance(key, tuple) and len(key) == 2: 

            i, j = key 

            if isinstance(i, slice) or isinstance(j, slice): 

                from sympy.matrices.expressions.slice import MatrixSlice 

                return MatrixSlice(self, i, j) 

            i, j = sympify(i), sympify(j) 

            if self.valid_index(i, j) != False: 

                return self._entry(i, j) 

            else: 

                raise IndexError("Invalid indices (%s, %s)" % (i, j)) 

        elif isinstance(key, (int, Integer)): 

            # row-wise decomposition of matrix 

            rows, cols = self.shape 

            if not (isinstance(rows, Integer) and isinstance(cols, Integer)): 

                raise IndexError("Single index only supported for " 

                                 "non-symbolic matrix shapes.") 

            key = sympify(key) 

            i = key // cols 

            j = key % cols 

            if self.valid_index(i, j) != False: 

                return self._entry(i, j) 

            else: 

                raise IndexError("Invalid index %s" % key) 

        elif isinstance(key, (Symbol, Expr)): 

                raise IndexError("Single index only supported for " 

                                 "non-symbolic indices.") 

        raise IndexError("Invalid index, wanted %s[i,j]" % self) 

 

    def as_explicit(self): 

        """ 

        Returns a dense Matrix with elements represented explicitly 

 

        Returns an object of type ImmutableMatrix. 

 

        Examples 

        ======== 

 

        >>> from sympy import Identity 

        >>> I = Identity(3) 

        >>> I 

        I 

        >>> I.as_explicit() 

        Matrix([ 

        [1, 0, 0], 

        [0, 1, 0], 

        [0, 0, 1]]) 

 

        See Also 

        ======== 

        as_mutable: returns mutable Matrix type 

 

        """ 

        from sympy.matrices.immutable import ImmutableMatrix 

        return ImmutableMatrix([[    self[i, j] 

                            for j in range(self.cols)] 

                            for i in range(self.rows)]) 

 

    def as_mutable(self): 

        """ 

        Returns a dense, mutable matrix with elements represented explicitly 

 

        Examples 

        ======== 

 

        >>> from sympy import Identity 

        >>> I = Identity(3) 

        >>> I 

        I 

        >>> I.shape 

        (3, 3) 

        >>> I.as_mutable() 

        Matrix([ 

        [1, 0, 0], 

        [0, 1, 0], 

        [0, 0, 1]]) 

 

        See Also 

        ======== 

        as_explicit: returns ImmutableMatrix 

        """ 

        return self.as_explicit().as_mutable() 

 

    def __array__(self): 

        from numpy import empty 

        a = empty(self.shape, dtype=object) 

        for i in range(self.rows): 

            for j in range(self.cols): 

                a[i, j] = self[i, j] 

        return a 

 

    def equals(self, other): 

        """ 

        Test elementwise equality between matrices, potentially of different 

        types 

 

        >>> from sympy import Identity, eye 

        >>> Identity(3).equals(eye(3)) 

        True 

        """ 

        return self.as_explicit().equals(other) 

 

    def canonicalize(self): 

        return self 

 

    def as_coeff_mmul(self): 

        return 1, MatMul(self) 

 

 

class MatrixElement(Expr): 

    parent = property(lambda self: self.args[0]) 

    i = property(lambda self: self.args[1]) 

    j = property(lambda self: self.args[2]) 

    _diff_wrt = True 

 

    def doit(self, **kwargs): 

        deep = kwargs.get('deep', True) 

        if deep: 

            args = [arg.doit(**kwargs) for arg in self.args] 

        else: 

            args = self.args 

        return args[0][args[1], args[2]] 

 

 

class MatrixSymbol(MatrixExpr): 

    """Symbolic representation of a Matrix object 

 

    Creates a SymPy Symbol to represent a Matrix. This matrix has a shape and 

    can be included in Matrix Expressions 

 

    >>> from sympy import MatrixSymbol, Identity 

    >>> A = MatrixSymbol('A', 3, 4) # A 3 by 4 Matrix 

    >>> B = MatrixSymbol('B', 4, 3) # A 4 by 3 Matrix 

    >>> A.shape 

    (3, 4) 

    >>> 2*A*B + Identity(3) 

    I + 2*A*B 

    """ 

    is_commutative = False 

 

    def __new__(cls, name, n, m): 

        n, m = sympify(n), sympify(m) 

        obj = Basic.__new__(cls, name, n, m) 

        return obj 

 

    def _hashable_content(self): 

        return(self.name, self.shape) 

 

    @property 

    def shape(self): 

        return self.args[1:3] 

 

    @property 

    def name(self): 

        return self.args[0] 

 

    def _eval_subs(self, old, new): 

        # only do substitutions in shape 

        shape = Tuple(*self.shape)._subs(old, new) 

        return MatrixSymbol(self.name, *shape) 

 

    def __call__(self, *args): 

        raise TypeError( "%s object is not callable" % self.__class__ ) 

 

    def _entry(self, i, j): 

        return MatrixElement(self, i, j) 

 

    @property 

    def free_symbols(self): 

        return set((self,)) 

 

    def doit(self, **hints): 

        if hints.get('deep', True): 

            return type(self)(self.name, self.args[1].doit(**hints), 

                    self.args[2].doit(**hints)) 

        else: 

            return self 

 

    def _eval_simplify(self, **kwargs): 

        return self 

 

class Identity(MatrixExpr): 

    """The Matrix Identity I - multiplicative identity 

 

    >>> from sympy.matrices import Identity, MatrixSymbol 

    >>> A = MatrixSymbol('A', 3, 5) 

    >>> I = Identity(3) 

    >>> I*A 

    A 

    """ 

 

    is_Identity = True 

 

    def __new__(cls, n): 

        return super(Identity, cls).__new__(cls, sympify(n)) 

 

    @property 

    def rows(self): 

        return self.args[0] 

 

    @property 

    def cols(self): 

        return self.args[0] 

 

    @property 

    def shape(self): 

        return (self.args[0], self.args[0]) 

 

    def _eval_transpose(self): 

        return self 

 

    def _eval_trace(self): 

        return self.rows 

 

    def _eval_inverse(self): 

        return self 

 

    def conjugate(self): 

        return self 

 

    def _entry(self, i, j): 

        if i == j: 

            return S.One 

        else: 

            return S.Zero 

 

    def _eval_determinant(self): 

        return S.One 

 

 

class ZeroMatrix(MatrixExpr): 

    """The Matrix Zero 0 - additive identity 

 

    >>> from sympy import MatrixSymbol, ZeroMatrix 

    >>> A = MatrixSymbol('A', 3, 5) 

    >>> Z = ZeroMatrix(3, 5) 

    >>> A+Z 

    A 

    >>> Z*A.T 

    0 

    """ 

    is_ZeroMatrix = True 

 

    def __new__(cls, m, n): 

        return super(ZeroMatrix, cls).__new__(cls, m, n) 

 

    @property 

    def shape(self): 

        return (self.args[0], self.args[1]) 

 

 

    @_sympifyit('other', NotImplemented) 

    @call_highest_priority('__rpow__') 

    def __pow__(self, other): 

        if other != 1 and not self.is_square: 

            raise ShapeError("Power of non-square matrix %s" % self) 

        if other == 0: 

            return Identity(self.rows) 

        return self 

 

    def _eval_transpose(self): 

        return ZeroMatrix(self.cols, self.rows) 

 

    def _eval_trace(self): 

        return S.Zero 

 

    def _eval_determinant(self): 

        return S.Zero 

 

    def conjugate(self): 

        return self 

 

    def _entry(self, i, j): 

        return S.Zero 

 

    def __nonzero__(self): 

        return False 

 

    __bool__ = __nonzero__ 

 

 

def matrix_symbols(expr): 

    return [sym for sym in expr.free_symbols if sym.is_Matrix] 

 

from .matmul import MatMul 

from .matadd import MatAdd 

from .matpow import MatPow 

from .transpose import Transpose 

from .inverse import Inverse