`subsindex`

Método que uma classe sobrecarrega para que seus objetos possam servir de índices de array.

Sintaxe

ind = subsindex(obj)

Retorna o índice base zero que obj representa quando aparece entre parênteses.

Descrição

Quando um objeto aparece como índice, como em v(obj), o MATLAB chama o método subsindex da classe e soma um ao resultado. O método devolve valores base zero, uma convenção histórica, então uma classe que guarda uma posição base um precisa subtrair um.

Arrays numéricos, lógicos e de char comuns não têm subsindex; chamá-lo neles é um erro que cita a classe do argumento.

Argumentos de entrada

obj: Um objeto de uma classe que define subsindex.

Argumentos de saída

ind: Array numérico de índices base zero, de modo que o valor 0 seleciona o primeiro elemento.

Exemplo

O método não existe para números comuns

try
    subsindex(5)
catch err
    disp(err.message)
end

Saída

Function 'subsindex' is not defined for values of class 'double'.

Observações

O MatLivre não aceita objetos como índices: v(obj) informa que a indexação com essa classe não é suportada, mesmo que a classe defina subsindex. O texto do erro do exemplo pode diferir do do MATLAB.

Veja também

subsref numArgumentsFromSubscript substruct find