Core code for package development and general use (sknano.core)¶
Contents¶
Functions¶
Custom iterators:
cyclic_pairs(iterable) |
Generate a cyclic list of all pair subsequences of elements from the input iterable. |
Array functions:
rezero_array(a[, epsilon]) |
Rezero elements of array a with absolute value less than or equal to epsilon. |
Meta functions:
check_type(value[, allowed_types]) |
Check object value type against tuple of allowed_types. |
deprecated([replacement]) |
Deprecated decorator. |
get_object_signature(obj) |
Get the signature from obj |
memoize(f[, cache]) |
memoization function to cache dict mapping |
method_function(module, classobj) |
|
timethis(func) |
Decorator that reports execution time. |
methodfunc(classobj, methodname[, reversed]) |
Define functions from existing class methods. |
with_doc(method[, use_header]) |
Decorator class to combine class method docstrings. |
I/O functions:
get_fname([fname, ext, outpath, overwrite, ...]) |
Generate modified fname string based on chosen parameters. |
get_fpath([fname, ext, outpath, overwrite, ...]) |
Generate absolute path to modified fname. |
String functions:
pluralize(word, count) |
Make a word plural by adding an s if count != 1. |
Sub-packages¶
- atoms (
sknano.core.atoms) - math (
sknano.core.math) - physics (
sknano.core.physics) - refdata (
sknano.core.refdata)