|
seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
|
Primitive rings (Franzblau) and their labels. More...
Functions | |
| SEAMS_API seams_status | seams_rings_find (seams_system *sys, double cutoff, int type, int graph, int max_depth, seams_rings **out) |
| Primitive rings (Franzblau) up to a maximum size. | |
| SEAMS_API void | seams_rings_destroy (seams_rings *rings) |
| Free a ring set. | |
| SEAMS_API int | seams_rings_count (const seams_rings *rings) |
| Number of primitive rings, as an int. | |
| SEAMS_API seams_status | seams_rings_histogram (const seams_rings *rings, int *counts, int counts_len) |
| Count primitive rings by size, with an int length. | |
| SEAMS_API seams_status | seams_rings_labels (const seams_rings *rings, int *sizes, int *symmetry) |
| Size and symmetry of each ring, without buffer lengths. | |
| SEAMS_API seams_status | seams_rings_vertices (const seams_rings *rings, int index, int *atoms, size_t cap, size_t *n_out) |
| Atom indices of one ring. | |
| SEAMS_API seams_status | seams_rings_chordless (const seams_neighbours *nb, int size, int *rings, size_t rings_len, size_t *n_rings, int *per_atom, size_t per_atom_len) |
| Chordless cycles of one size. | |
| SEAMS_API seams_status | seams_rings_fraction (const seams_rings *rings, int size, double *fraction) |
| Fraction of atoms that sit on a ring. | |
Primitive rings (Franzblau) and their labels.
| SEAMS_API seams_status seams_rings_chordless | ( | const seams_neighbours * | nb, |
| int | size, | ||
| int * | rings, | ||
| size_t | rings_len, | ||
| size_t * | n_rings, | ||
| int * | per_atom, | ||
| size_t | per_atom_len ) |
Chordless cycles of one size.
A cycle is chordless when no edge of the graph joins two of its vertices that are not next to each other on the cycle. Every primitive ring is chordless; a chordless cycle need not be primitive. Each cycle is written once as size atom indices: it starts at its lowest index and runs towards the smaller of that atom's two cycle neighbours. Cycles are sorted lexicographically, so the list does not depend on the thread count.
| nb | Graph from seams_neighbours_build(). |
| size | Cycle length, from 3 through 12. |
| rings | Caller buffer of size times the cycle count ints, or NULL to skip the list. |
| rings_len | Length of rings in ints. Ignored when rings is NULL. |
| n_rings | Receives the cycle count. Required when rings is not NULL. |
| per_atom | Caller buffer of one int per atom, or NULL. Receives the number of cycles through each atom. |
| per_atom_len | Length of per_atom. Ignored when per_atom is NULL. |
| SEAMS_API int seams_rings_count | ( | const seams_rings * | rings | ) |
Number of primitive rings, as an int.
ABI 1 query. seams_rings_nrings() reports errors.
| rings | Ring handle, or NULL. |
| SEAMS_API void seams_rings_destroy | ( | seams_rings * | rings | ) |
Free a ring set.
| rings | Handle from seams_rings_find(), or NULL. NULL is ignored. |
| SEAMS_API seams_status seams_rings_find | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | graph, | ||
| int | max_depth, | ||
| seams_rings ** | out ) |
Primitive rings (Franzblau) up to a maximum size.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| graph | SEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL. |
| max_depth | Largest ring size, from 3 through 12. |
| out | Receives a new handle. On failure *out is NULL. |
| SEAMS_API seams_status seams_rings_fraction | ( | const seams_rings * | rings, |
| int | size, | ||
| double * | fraction ) |
Fraction of atoms that sit on a ring.
| rings | Ring handle. |
| size | Ring size to count. Zero counts atoms that sit on any ring. |
| fraction | Receives a value in [0, 1]. |
| SEAMS_API seams_status seams_rings_histogram | ( | const seams_rings * | rings, |
| int * | counts, | ||
| int | counts_len ) |
Count primitive rings by size, with an int length.
ABI 1 entry. New callers use seams_rings_histogram_n().
| rings | Ring handle. |
| counts | Caller buffer. counts[k] receives the number of rings of size k. Sizes outside the buffer are ignored. |
| counts_len | Length of counts. Must be positive. |
| SEAMS_API seams_status seams_rings_labels | ( | const seams_rings * | rings, |
| int * | sizes, | ||
| int * | symmetry ) |
Size and symmetry of each ring, without buffer lengths.
ABI 1 entry. Each non-NULL buffer has length seams_rings_count(rings). New callers use seams_rings_labels_n(), which checks the lengths.
| rings | Ring handle. |
| sizes | One int per ring, or NULL. |
| symmetry | One seams_ring_symmetry code per ring, or NULL. The two pointers may not both be NULL. |
| SEAMS_API seams_status seams_rings_vertices | ( | const seams_rings * | rings, |
| int | index, | ||
| int * | atoms, | ||
| size_t | cap, | ||
| size_t * | n_out ) |
Atom indices of one ring.
| rings | Ring handle. |
| index | Ring index, from 0 to seams_rings_count(rings) - 1. |
| atoms | Caller buffer, or NULL to query. |
| cap | Capacity of atoms. Ignored when atoms is NULL. |
| n_out | Receives the vertex count. |