charge_truths

charge_truths(ne=False)

Returns a binary vector indicating which species are charged.

Parameters

ne : bool, optional

If True, excludes "e-". Default False.

Returns

Vector[int]

1 for charged species, 0 for neutral.

Examples

s = Species(["H2", "H+", "e-"])
print(s.charge_truths())
print(s.charge_truths(ne=True))

Output

[0, 1, 1]
[0, 1]