Skip to content

Latest commit

 

History

History
221 lines (200 loc) · 21.8 KB

Status.md

File metadata and controls

221 lines (200 loc) · 21.8 KB
Raw

Implementation Status

This document lays out the current implementation status of each function/feature, as well as the plans for Nifty's future.

Table Key

Implementation Status
  • N/A: This feature is internal or private and implemented ad hoc
  • Unimplemented: This feature exists or will exist, but no functionality has been implemented
  • Incomplete: Implementation of this feature has begun, but critical parts are unfinished
  • Mostly Complete: Most or all parts of this feature are implemented but still need a little work
  • Complete: This feature is completely implemented, though there may still be planned improvements
Test Coverage
  • N/A: This feature is internal or it is a feature for which testing does not make sense
  • None: There are no unit tests specific to this feature; even if it is used indirectly in other unit tests, we should have tests targeting this feature in isolation
  • Basic: At least one basic unit test (possibly just a sanity check) exists for this feature
  • Substantial: Most, if not all, of this feature's critical paths are being tested
  • Benchmarked: This feature has substantial test coverage for correctness, as well as performance benchmarking

There is no Complete status for test coverage because there are always additional tests to be implemented.

Nifty 1.0

Version 1.0 represents a very early beta release. Unless version 1.0 is specifically required, it's preferrable to use the latest master.

Nifty 2.0

Estimated release: late 2018

Feature Status Test Coverage Notes
acos Complete Basic
acosd Complete Basic
acosh Complete Basic
asin Complete Basic
asind Complete Basic
asinh Complete Basic
atan Complete Basic
atan2 Complete Basic
atan2d Complete Basic
atand Complete Basic
atanh Complete Basic
ceil Complete Basic
chol Mostly complete Basic
cond Unimplemented None
cos Complete Basic
cosd Complete Basic
cosh Complete Basic
cross Mostly complete Basic
det Unimplemented None
diag Unimplemented None
dot Mostly complete Basic Need to add overloads for types other than Vecotr
eig Unimplemented None
eps Incomplete None Use feature from standard lib from Swift 4.0
eq Completed Basic
exp Complete Basic
exp2 Complete Basic
expm1 Complete Basic
eye Mostly Complete None
flipud Unimplemented None
fliplr Unimplemented None
floor Complete Basic
ge (>=) Complete None
gt (>) Unimplemented None
hypot Mostly Complete None
ind2sub Mostly Complete None
inf Incomplete None
inv (~) Mostly Complete None
isequal Mostly Complete None Need to add overloads and improve default behavior
isinf Unimplemented None
isnan Incomplete None
ldivide Unimplemented None
le (<=) Complete None
log Complete Basic
log10 Complete Basic
log2 Complete Basic
log1p Complete Basic
lsb Unimplemented None
lt (<) Complete None
lu Mostly Complete Basic
Matrix Mostly Complete Basic Need to add reshaping inits; make iterable
max Unimplemented None
mean Mostly complete Basic Needs definitions for tensor
median Unimplemented None
min Unimplemented None
minus (-) Mostly Complete Basic Need to add overloads
mldivide (-/) Complete Basic
mode Unimplemented None
mpower (**) Unimplemented None
mrdivide (/) Complete Basic Current implementation is less efficient--does more transposes than necessary
msb Mostly Complete None
mtimes (*) Mostly Complete None Need to add overloads for other than Matrix*Matrix
MultikeyDictionary Mostly Complete Substantial Currently only have basic insert/find/remove; consider rename
mvnrnd Mostly Complete Basic
nan Incomplete None
ndims Complete None
ne Unimplemented None
Nifty Incomplete None Option sets and constants; revisit naming convention
norm Incomplete Basic L2 norm complete, need L1, frobenius, etc...
numel Complete None
ones Mostly Complete None
pinv Unimplemented None
plus (+) Mostly Complete Basic Need to add overloads
pow (**) Complete None
power (.**) Unimplemented None
prod Unimplemented None
qr Unimplemented None
rand Complete None
randa Mostly Complete None
randi Complete None
randn Complete None
randperm Unimplemented None
rank Unimplemented None
rdivide Incomplete None Has division overloads but needs rdivide func definition and overloads for other types
reshape Unimplemented None
rmap Complete None
round Complete Basic
rref Unimplemented None
shuffle Unimplemented None Need this and randperm?
sin Complete Basic
sind Complete Basic
sinh Complete Basic
size Complete Basic
sqrt Complete Basic
std Unimplemented None
sub2ind Mostly Complete None
sum Mostly Complete Basic
svd Mostly Complete Basic Need to resolve ambiguity between function calls requiring specifying output type
swap Incomplete None Need to add support for vectors, tensors, matrix columns, etc.
tan Complete Basic
tand Complete Basic
tanh Complete Basic
Tensor Mostly complete Basic Need to add reshaping inits; make iterable
tic Mostly Complete None
times (*) Incomplete None Need to add overloads
toc Mostly Complete None
trace Complete Basic
transpose Mostly Complete None Need to add overloads for generic types
tril Incomplete None
triu Incomplete None
unique Unimplemented None
var Unimplemented None
Vector Mostly complete Basic Need to add reshaping inits; make iterable
zeros Complete Basic

Nifty 2.1

Estimated release: late 2018 - early 2019

Feature Status Test Coverage Notes
cumprod Unimplmented None
cumsum Unimplmented None
fft Unimplemented None
filter Unimplemented None Need to decide how to handle higher order functions
find Incomplete None Interface created for use with DataSeries -- need to reconcile it with MATLAB
ifft Unimplemented None
linspace Unimplemented None
map Unimplemented None Need to decide how to handle higher order functions
meshgrid Unimplemented None
poly Unimplemented None
reduce Unimplemented None Need to decide how to handle higher order functions
repmat Unimplemented None
sort Unimplemented None

Nifty 2.2

Estimated release: mid 2019

Anticipated features:

  • Basic optimization toolbox (e.g. fminsearch)
  • Data frames and series
  • Interpolation methods: e.g interp1, interp2, spline
  • Interface to a third party plotting library

Nifty 2.3

Estimated work begins: 2019

Start work on AI and machine learning features. Details TBD.

Future Work

This is an unorganized and vague list of ideas of things we might want to include with Nifty: