Skip to content

Commit

Permalink
* Bumped version 0.1.0
Browse files Browse the repository at this point in the history
* Slight documentation improvements
  • Loading branch information
Ron Bessems committed Nov 26, 2018
1 parent b480f42 commit eb0a206
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 3 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
## [0.10.0] -- 11/26/2018

* Slight documentation modifications.

## [0.0.6] -- 11/26/2018

* Added Vector class.

## [0.0.5] -- 11/21/2018

* Dart minimum back to 2.0.0 fixed linter errors.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A Simple Linear Algebra Package.

This package is intended to be a portable easy to use linear algebra package. It does not have any dependencies outside of flutter itself, thus making it portable and easy to integrate.
This package is intended to be a portable easy to use linear algebra package. It does not have any dependencies outside of Dart itself, thus making it portable and easy to integrate.

Our goal is to keep the code readable, documented and maintainable.

Expand All @@ -28,7 +28,7 @@ true

## Complete Example

A more extensive example with various matrix operations. See the [Matrix API](https://pub.dartlang.org/documentation/linalg/latest/linalg/Matrix-class.html) for the full details.
A more extensive example with various matrix operations. See the [Matrix API](https://pub.dartlang.org/documentation/linalg/latest/linalg/Matrix-class.html) and [Vector API](https://pub.dartlang.org/documentation/linalg/latest/linalg/Vector-class.html) for the full details.

```dart
import 'package:linalg/linalg.dart';
Expand Down
14 changes: 14 additions & 0 deletions lib/matrix.dart
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@ class MatrixUnsupportedOperation extends MatrixException {
/// performance but for readability. You should be
/// able to read the functions and understand what
/// is going on with basic linear algebra knowledge.
///
/// ```dart
///final Matrix a = Matrix([[1, 2], [3, 4]]);
///final Vector b = Vector.column([2, 3]);
///final Matrix e = Matrix([[8], [18]]);
///Matrix result = a * b;
///print(result);
///print(result == e);
///```
///This prints
///```dart
///[[8.0], [18.0]]
///true
///```
class Matrix {
/// Constructs a matrix from a List<List<double>> value.
///
Expand Down
15 changes: 15 additions & 0 deletions lib/vector.dart
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,21 @@ enum VectorType { row, column }
/// is going on with basic linear algebra knowledge.
///
/// The vector can be either a row or column vector.
///
///
/// ```dart
///final Matrix a = Matrix([[1, 2], [3, 4]]);
///final Vector b = Vector.column([2, 3]);
///final Matrix e = Matrix([[8], [18]]);
///Matrix result = a * b;
///print(result);
///print(result == e);
///```
///This prints
///```dart
///[[8.0], [18.0]]
///true
///```
class Vector {
Vector._(this._matrix, this._vectorType) {
if (_vectorType == VectorType.row && this._matrix.m != 1) {
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: linalg
description: A Simple Linear Algebra Package enabling easy Matrix calculations.
version: 0.0.6
version: 0.1.0
author: Ron Bessems <rbessems@gmail.com>
homepage: https://github.com/altera2015/linalg

Expand Down

0 comments on commit eb0a206

Please sign in to comment.