Method register_ancestor

physo/physym/vect_programs.py:1184–1217

Registers tokens located at coords_dest in their own ancestor records (as a token counts as its own ancestor) and updates the number of ancestors. Depths must be up-to-date for this function to perform correctly. Parameters ---------- coords_dest : numpy.arra

(self, coords_dest, )

        self.tokens.n_ancestors        [coords_dest[0], coords_dest[1]] = nb           # (?,) of int

    def register_ancestor(self, coords_dest, ):
        """
        Registers tokens located at coords_dest in their own ancestor records (as a token counts as its own ancestor)
        and updates the number of ancestors. Depths must be up-to-date for this function to perform correctly.
        Parameters
        ----------
        coords_dest : numpy.array of shape (2, ?) of int
            Coords of tokens which's ancestors records should be updated, 0th array in batch dim and 1th array in time dim.
        """
        # ? = number of tokens which need their ancestor to be updated
        n_tokens = coords_dest.shape[1]

        # Records of ancestors positions for token at coords_dest (ie vectors of size ? of family lines)
        records_ancestors_pos = self.tokens.ancestors_pos[tuple(coords_dest)]  # (?, max_time_step) of int

        # Coords of locations in records_ancestors_pos where the new ancestors should be placed. Since we are
        # registering token as their own ancestors, this is performed at their own depth in the family line.
        coords_new_ancestors = np.stack((  # (2, ?,) of int
            np.arange(n_tokens),
            # token dim coord (always = [1,2,3..] because records_ancestors_pos is already the subset of interest)
            self.tokens.depth[tuple(coords_dest)],  # ancestor line dim coord ie own depth of tokens to affect
        ), axis=0)

        # Registering tokens as their own ancestors ie. adding own token positions (time dim) in their records
        records_ancestors_pos[tuple(coords_new_ancestors)] = coords_dest[1]
        self.tokens.ancestors_pos[tuple(coords_dest)] = records_ancestors_pos

        # Update number of ancestors
        self.tokens.n_ancestors[tuple(coords_dest)] = self.tokens.depth[tuple(coords_dest)] + 1

        # Update number of ancestors
        self.tokens.has_ancestors_mask[tuple(coords_dest)] = True

        return None

    def set_units (self, coords_dest, new_is_constraining_phy_units, new_phy_units):
        """