类方法(GNU Octave(版本10.1.0))

34.2类方法¶

有许多基本类方法可以(也应该)定义为允许查询和设置类的内容。其中最基本的是disp方法这里的disp每当类应该显示在屏幕上时,Octave都会使用方法。通常,这是不以分号结尾的Octave表达式的结果。如果没有定义这里的方法,那么Octave在显示aclass的内容时不会打印任何内容,这可能会令人困惑。

的一个示例disp多项式类的方法可能是

function disp (p)

  a = p.poly;
  first = true;
  for i = 1 : length (a);
    if (a(i) != 0)
      if (first)
        first = false;
      elseif (a(i) > 0 || isnan (a(i)))
        printf (" +");
      endif
      if (a(i) < 0)
        printf (" -");
      endif
      if (i == 1)
        printf (" %.5g", abs (a(i)));
      elseif (abs (a(i)) != 1)
        printf (" %.5g *", abs (a(i)));
      endif
      if (i > 1)
        printf (" X");
      endif
      if (i > 2)
        printf (" ^ %d", i - 1);
      endif
    endif
  endfor

  if (first)
    printf (" 0");
  endif
  printf ("\n");

endfunction

为了与Octave图形句柄类保持一致,类还应该定义get和set方法。这里的get方法接受一个或两个参数。第一个自变量是propertificass的对象。如果没有给出第二个参数,那么该方法应该返回一个具有类的所有属性的structure。如果提供了可选的第二个参数,则该参数应为属性名称,并且应检索指定的属性。

function val = get (p, prop)

  if (nargin < 1)
    print_usage ();
  endif

  if (nargin == 1)
    val.poly = p.poly;
  else
    if (! ischar (prop))
      error ("@polynomial/get: PROPERTY must be a string");
    endif

    switch (prop)
      case "poly"
        val = p.poly;
      otherwise
        error ('@polynomial/get: invalid PROPERTY "%s"', prop);
    endswitch
  endif

endfunction

类似地,的第一个参数set方法应该是一个对象,任何其他参数都应该是键/值对。

function pout = set (p, varargin)

  if (numel (varargin) < 2 || rem (numel (varargin), 2) != 0)
    error ("@polynomial/set: expecting PROPERTY/VALUE pairs");
  endif

  pout = p;
  while (numel (varargin) > 1)
    prop = varargin{1};
    val  = varargin{2};
    varargin(1:2) = [];
    if (! ischar (prop) || ! strcmp (prop, "poly"))
      error ("@polynomial/set: invalid PROPERTY for polynomial class");
    elseif (! (isreal (val) && isvector (val)))
      error ("@polynomial/set: VALUE must be a real vector");
    endif

    pout.poly = val(:).';  # force row vector
  endwhile

endfunction

请注意,Octave不实现按引用传递;因此,修改对象需要一个赋值语句,该语句使用set方法

p = set (p, "poly", [1, 0, 0, 0, 1]);

这里的set方法利用subsasgn方法,因此也必须定义此方法。这里的subsasgn方法将在下一节中进行更深入的讨论(详见索引对象).

最后,用户类可以被认为是一种特殊类型的结构体,它们可以以与结构体相同的方式保存到文件中。例如:

p = polynomial ([1, 0, 1]);
save userclass.mat p
clear p
load userclass.mat

支持的所有文件格式save和load支持。在某些情况下,用户类可能包含一个不需要保存的字段,或者一个在保存之前需要初始化的字段。这可以通过saveobj类的方法。

: b = saveobj (a) ¶

类的方法,以便在将对象保存到文件之前对其进行操作。

函数saveobj当对象a正在保存使用save作用的使用示例saveobj可能是删除对象中没有保存意义的字段,也可能用于确保在保存对象之前初始化对象的某些字段。例如

function b = saveobj (a)
  b = a;
  if (isempty (b.field))
     b.field = initfield (b);
  endif
endfunction

详见: loadobj, class.

saveobj在将类保存到文件之前调用。类似地loadobj方法是在从文件加载类之后立即调用的,可用于确保将任何删除的字段重新插入到用户对象中。