trans_sum_inbmax_penalty

pybrops.breed.prot.sel.transfn.trans_sum_inbmax_penalty(mat, inbmax, penalty_wt, axis=None, **kwargs)

Transform a numpy.ndarray by taking a summation across an axis.

Parameters:

• mat (numpy.ndarray) – An array to be transformed through summation.

• axis (None, int, tuple of ints) – Axis along which to take the summation.

• kwargs (dict) – Additional keyword arguments. Not used by this function.

Returns:

out – A summation transformed array.

Return type:

numpy.ndarray